Added CHANGELOG and CITATION

CHANGELOG

@@ -16,7 +16,6 @@ Added:
 - contributing
 Fixed:
 - updated docker base image
-- new URL for geology data
 
 ## [0.1] - 2024-01-30
 Added:

CITATION.cff

+cff-version: 1.2.0
+title: 'FACT Data: Geology and Mining'
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: dataset
+doi: 10.17605/OSF.IO/4PJDM
+authors:
+  - given-names: Riccardo
+    family-names: Boero
+    email: ribo@nilu.no
+    orcid: 'https://orcid.org/0000-0002-7468-9096'
+    affiliation: NILU
+identifiers:
+  - type: doi
+    value: 10.17605/OSF.IO/4PJDM
+    description: This DOI represents all software versions.
+repository-code: 'https://git.nilu.no/fact/data/FACT_ports'
+url: 'https://osf.io/4pjdm/'
+abstract: >-
+  Sea and inland waters ports location and tonnage in Europe and US.
+keywords:
+  - Sea port
+  - Inland waters port
+  - Tonnage
+  - Europe
+  - Eurostat
+  - US
+  - US BTS
+  - Trasnportation statistics
+license: CC-BY-4.0

README.md

 # FACT Sea and Inland Water Ports
 Sea and inland waters ports location and tonnage in Europe and US.
----
-## Use
-Connect to the GitLab container registry with privileges for the FACT group:
-
 
->docker login -u FACT_token -p glpat-1zG-TQx___xLsPjj2vsG registry.git.nilu.no
+---
 
+[![GitLab License](https://img.shields.io/gitlab/license/fact%2Fdata%2FFACT_mine?gitlab_url=https%3A%2F%2Fgit.nilu.no&style=flat&color=orange)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
+[![DOI](https://img.shields.io/badge/DOI-10.17605%2FOSF.IO%2F4PJDM-blue?style=flat)](https://doi.org/10.17605/OSF.IO/4PJDM)
+[![Data License](https://img.shields.io/badge/data-CC%20BY%204.0-green)](https://creativecommons.org/licenses/by/4.0/legalcode.txt)
 
-Run this data service:
+---
 
+## Use
+1. Pull the image:
+> docker pull registry.git.nilu.no/fact/data/fact_ports:latest
 
+2. Run this data service:
 >docker run -t -i --name fact_ports -e MARIADB_DATABASE=FACT_ports -e MYSQL_ROOT_PASSWORD=devops -p 3312:3306 -d registry.git.nilu.no/fact/data/fact_ports:0.1
 
 The container makes available a MariaDB instance with the full database on sea and inland waters ports **FACT_ports**. It is reachable on port 3312 of the localhost and the root password is 'devops'.
@@ -50,7 +53,24 @@ The Principal Port dataset contains port codes, port names, geographic locations
 https://geodata.bts.gov/datasets/usdot::principal-ports/about
 
 ---
-### Authors
+## Author
 Riccardo Boero - ribo@nilu.no
 
-### License
+## Licenses
+All the code and the resulting docker images in this project are subject to:
+- [GNU Generla Public License v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html).
+
+The data is released under: 
+- [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.
+
+The input data is licensed as:
+- EU power palants follows [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) license.
+- ENTSOE data [terms of use](https://transparency.entsoe.eu/content/static_content/download?path=/Static%20content/terms%20and%20conditions/181108_ENTSOE_Transparency_Terms_Conditions_MC_APPROVED.pdf&loggedUserIsPrivileged=false).
+- EIA public domain [data copyrights](https://www.eia.gov/about/copyrights_reuse.php).
+
+## Citation
+- Boero, Riccardo. 2024. “FACT Data: Sea and Inland Waters.” OSF. [doi:10.17605/OSF.IO/4PJDM](https://doi.org/10.17605/OSF.IO/4PJDM). 
+
+Part of the Fine scAle eConomic daTa - FACT project:
+- Boero, Riccardo. 2024. “Fine scAle eConomic daTa - FACT.” OSF. [doi:10.17605/OSF.IO/PV4ZW](https://doi.org/10.17605/OSF.IO/PV4ZW). 
+