Changed README to account for problems with running the CI

README.md

@@ -1,31 +1,36 @@
 # EnergyModelsRenewableProducers
 
-[![Pipeline: passing](https://gitlab.sintef.no/clean_export/energymodelsrenewableproducers.jl/badges/main/pipeline.svg)](https://gitlab.sintef.no/clean_export/energymodelsrenewableproducers.jl/-/jobs)
-[![Docs: stable](https://img.shields.io/badge/docs-stable-4495d1.svg)](https://clean_export.pages.sintef.no/energymodelsrenewableproducers.jl)
-<!--- [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
---->
 `EnergyModelsRenewableProducers` is a package to model renewable power generation
-technologies. It extends the `EnergyModelsBase` package with non-dispatchable power generation from sources such as wind turbines.
+technologies.
+It extends the [`EnergyModelsBase`](https://github.com/EnergyModelsX/EnergyModelsBase.jl) package with non-dispatchable power generation from sources such as wind turbines as well as modelling of hydro power..
 
 > **Note**
-> This is an internal pre-release not intended for distribution outside the project consortium. 
+> We migrated recently from an internal Git solution to GitHub, including the package [`TimeStruct`](https://github.com/sintefore/TimeStruct.jl). As both `TimeStruct` and `EnergyModelsBase` are not yet registered, it is not possible to build automatically the documentation or run the tests without significant changes in the CI. Every user is however free to build the documentation from the [`docs`](docs) folder.
 
 ## Usage
 
-The [documentation](https://clean_export.pages.sintef.no/energymodelsrenewableproducers.jl/) for `EnergyModelsRenewableProducers` is in development.
+The documentation for `EnergyModelsRenewableProducers` is currently not uploaded as we migrated recently to GitHub.
+Once `TimeStruct` and `EnergyModelsBase` are registered in the Julia Registry, we will update the README.md  and add the links to the documentation.
 
 See examples of usage of the package and a simple guide for running them in the folder [`examples`](examples).
 
-<!---
-## Documentation
-
-The documentation is built with [Documenter.jl](https://juliadocs.github.io/Documenter.jl/stable/) can be generated by running
-```shell
-$ cd docs
-$ julia make.jl
+## Cite
+
+If you find `EnergyModelsGeography` useful in your work, we kindly request that you cite the following publication:
+
+```@article{boedal_2024,
+  title = {Hydrogen for harvesting the potential of offshore wind: A North Sea case study},
+  journal = {Applied Energy},
+  volume = {357},
+  pages = {122484},
+  year = {2024},
+  issn = {0306-2619},
+  doi = {https://doi.org/10.1016/j.apenergy.2023.122484},
+  url = {https://www.sciencedirect.com/science/article/pii/S0306261923018482},
+  author = {Espen Flo Bødal and Sigmund Eggen Holm and Avinash Subramanian and Goran Durakovic and Dimitri Pinel and Lars Hellemo and Miguel Muñoz Ortiz and Brage Rugstad Knudsen and Julian Straus}
+}
 ```
---->
 
 ## Project Funding
 
-`EnergyModelsRenewableProducers` was funded by the Norwegian Research Council in the project [Clean Export](https://www.sintef.no/en/projects/2020/cleanexport/), project number [308811](https://prosjektbanken.forskningsradet.no/project/FORISS/308811)
+The development of `EnergyModelsRenewableProducers` was funded by the Norwegian Research Council in the project [Clean Export](https://www.sintef.no/en/projects/2020/cleanexport/), project number [308811](https://prosjektbanken.forskningsradet.no/project/FORISS/308811)