docs: add CHANGELOG

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Change Log
+
+## 0.1.0
+
+Released on August 22, 2021.
+
+### Added
+
+First version of the MetaCall Jupyter kernel that follows the wrapper kernel mechanism using IPython and the Jupyter client:
+
+- Setup the wrapper kernel using IPython and the Jupyter client.
+- Integrated the Polyglot REPL into the Jupyter client and added support for Python & NodeJS.
+- Added user-experience features for the kernel such as `$loadfile`, `$loadcell`, `$inspect` to load foreign modules and implement cross-language function calls. More information [here](https://metacall-jupyter-kernel.readthedocs.io/en/latest/getting-started.html#running-a-notebook).
+- Added support to run Shell commands from the kernel.
+- Implemented the CI/CD pipelines for the project using GitHub Actions.
+- Containerized the project using [Docker](https://www.docker.com/).
+- Implemented the tests for the project using PyTest.
+- Developed the documentation using Sphinx, published on ReadTheDocs [here](https://metacall-jupyter-kernel.readthedocs.io/en/latest/).

README.md

@@ -101,6 +101,8 @@ To get started with contributing, check out the [Code of Conduct](CODE_OF_CONDUC
 
 If you are new to Git & GitHub, you can find more information [here](https://metacall-jupyter-kernel.readthedocs.io/en/latest/contributing.html). It contains all the information about making the changes, linting, running the CI locally and submitting the pull request.
 
+You can view the [Change Log](CHANGELOG.md) to see what has changed in the project, since its inception.
+
 ## LICENSE
 
 [Apache-2.0 License](LICENSE)

docs/changelog.rst

@@ -0,0 +1,29 @@
+Change Log
+==========
+
+0.1.0
+-----
+
+Released on August 22, 2021.
+
+Added
+~~~~~
+
+First version of the MetaCall Jupyter kernel that follows the wrapper
+kernel mechanism using IPython and the Jupyter client:
+
+-  Setup the wrapper kernel using IPython and the Jupyter client.
+-  Integrated the Polyglot REPL into the Jupyter client and added
+   support for Python & NodeJS.
+-  Added user-experience features for the kernel such as ``$loadfile``,
+   ``$loadcell``, ``$inspect`` to load foreign modules and implement
+   cross-language function calls. More information `here`_.
+-  Added support to run Shell commands from the kernel.
+-  Implemented the CI/CD pipelines for the project using GitHub Actions.
+-  Containerized the project using `Docker`_.
+-  Implemented the tests for the project using PyTest.
+-  Developed the documentation using Sphinx, published on ReadTheDocs
+   `here <https://metacall-jupyter-kernel.readthedocs.io/en/latest/>`__.
+
+.. _here: https://metacall-jupyter-kernel.readthedocs.io/en/latest/getting-started.html#running-a-notebook
+.. _Docker: https://www.docker.com/

docs/index.rst

@@ -53,3 +53,4 @@ that the `Jupyter`_ notebook understands, and thus eventually displayed.
    usage
    autodoc
    contributing
+   changelog