diff --git a/CHANGELOG.org b/CHANGELOG.org index 8870e1c..8e95a79 100644 --- a/CHANGELOG.org +++ b/CHANGELOG.org @@ -49,3 +49,5 @@ Add the CI/CD configuration. ** 1.2.3 <2023-07-16> Fix the command that was "ans", but it must be "asn". +** 1.2.4 <2023-07-16> + Update the README. diff --git a/README.rst b/README.rst index 83e6e56..92718d6 100644 --- a/README.rst +++ b/README.rst @@ -4,6 +4,27 @@ Anitube Simple Notification Anitube Simple Notification is a application made for getting notification when a content is updated on the web-site (anitube.in.ua). +Install +======= + +Ensure that python and pip are installed: + +.. code:: shell + + python --version + python -m pip -V + # or + python3 --version + python3 -m pip -V + +Install the package: + +.. code:: shell + + pip install anitube-simple-notification + # or + pip3 install anitube-simple-notification + Usage ===== @@ -30,8 +51,8 @@ Run the program by one of the commands: .. code:: shell - python3 main.py - python main.py + anitube-simple-notification + asn Author ====== diff --git a/pyproject.toml b/pyproject.toml index 91a4862..58acc77 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "anitube-simple-notification" -version = "1.2.2" +version = "1.2.4" authors = [ { name="Kostiantyn Klochko", email="kklochko@protonmail.com" }, ]