Merge pull request #2 from bis-med-it/changelog

Add a changelog

CHANGELOG.rst

@@ -0,0 +1,9 @@
+Changelog
+=========
+
+All notable changes to this project are listed in the *release notes* published
+with the `project documentation <https://bis-med-it.github.io/pysdmx>`_ .
+
+The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
+and this project adheres to 
+`Semantic Versioning <https://semver.org/spec/v2.0.0.html)>`_.

README.rst

@@ -1,31 +1,25 @@
 ``pysdmx`` in a nutshell
 ========================
 
-``pysdmx`` is an **opinionated** and **pragmatic** SDMX library written in
-Python. It supports a **subset** of what SDMX offers and aims at 
-keeping things **simple** whenever possible, so that using the library does
-**not** require advance knowledge of SDMX.
+``pysdmx`` is a pragmatic and **opinionated** library written in Python. It
+focuses on simplicity, providing a subset of SDMX functionalities without
+requiring advanced knowledge of SDMX.
 
-``pysdmx`` aims to be a versatile SDMX toolbox for Python and,
-therefore, covers different use cases, a few of which are 
-highlighted below:
+Key features:
 
 - **SDMX information model in Python**: ``pysdmx`` offers Python classes
-  representing a **simplified subset of the SDMX information model**, thereby
-  enabling a domain-driven development of SDMX processes in Python. The model
+  representing a **simplified subset of the SDMX information model**,
+  enabling a domain-driven development of SDMX processes with Python. These
   classes are serializable.
-- **Metadata in action**: One of the main features of ``pysdmx`` is to
-  support retrieving metadata from a SDMX Registry (or any service compliant
-  with the SDMX-REST 2.0.0 API), so that you can use them to power statistical
-  processes.
-- **Data discovery and data retrieval**: This functionality is **not
-  available yet** but is on the development roadmap. In a nutshell, ``pysdmx``
-  will allow listing public SDMX services, discovering the data available in
-  these various services and retrieving data from these various services.
+- **Metadata in action**: ``pysdmx`` supports retrieving metadata from an SDMX
+  Registry or any service compliant with the SDMX-REST 2.0.0 API. Use these
+  metadata to power statistical processes.
+- **Data discovery and retrieval**: This functionality is under development.
+  ``pysdmx`` will enable listing public SDMX services, discovering available
+  data available, and retrieving data from these services.
 
-``pysdmx`` is published to `PyPI <https://pypi.org/>`_ and can be
-installed using your preferred option (``pip``, ``pipx``, ``poetry``,
-etc.).
+``pysdmx`` is available on `PyPI <https://pypi.org/>`_ and can be
+installed using options such as pip, pipx, poetry, etc.
 
-For additional information, please refer to the
-`project documentation <https://bis-med-it.github.io/pysdmx>`_.
+For more details, check the `project documentation 
+<https://bis-med-it.github.io/pysdmx>`_.

docs/release.rst

@@ -4,7 +4,10 @@ Release notes
 1.0.0-beta-1
 ------------
 
-- **Feature**: Implement core SDMX model classes
-- **Feature**: Implement sync and async clients to retrieve metadata
+Added
+^^^^^
+
+- Core SDMX model classes
+- Sync and async clients to retrieve metadata
   from an SDMX Registry or SDMX-REST service
-- **Feature**: Implement helper functions to handle SDMX URNs
+- Helper functions to handle SDMX URNs