Merge pull request #20 from treyhunner/improve-docs

Add screenshots to documentation
treyhunner · Dec 30, 2021 · 7b2a275 · 7b2a275
2 parents 7c780ce + 6b58f0d
commit 7b2a275
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -35,13 +35,35 @@ countdown-cli
    :target: https://github.com/psf/black
    :alt: Black
 
+This project is based on a `Python Morsels`_ exercise for a command-line countdown timer.
+If you're working on that exercise right now, please **don't look at the source code** for this. 😉
+
+|Logo|
+
+.. |Logo| image:: images/python-morsels-logo.png
+   :target: https://www.pythonmorsels.com
+   :width: 400
+   :alt: an adorable snake taking a bite out of a cookie with the words Python Morsels next to it (Python Morsels logo)
+
 
 Features
 --------
 
 * Full-screen countdown timer, centered in the terminal window
 * Command-line interface for Linux/Mac/Windows
 
+|32:53|
+
+|14:57|
+
+.. |32:53| image:: images/3253.png
+   :width: 500
+   :alt: 32:53 shown in large letters in center of an xterm window (black background with white text)
+
+.. |14:57| image:: images/1457.png
+   :width: 500
+   :alt: 14:57 shown in large letters in center of terminal window (light background with darker text)
+
 
 Requirements
 ------------
@@ -56,7 +78,7 @@ You can install *countdown-cli* via pip_ from PyPI_:
 
 .. code:: console
 
-   $ pip install countdown-cli
+   $ python3 -m pip install countdown-cli
 
 
 Usage
@@ -91,10 +113,11 @@ Credits
 
 This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.
 
+.. _Python Morsels: https://www.pythonmorsels.com
 .. _@cjolowicz: https://github.com/cjolowicz
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _MIT license: https://opensource.org/licenses/MIT
-.. _PyPI: https://pypi.org/
+.. _PyPI: https://pypi.org/project/countdown-cli/
 .. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
 .. _file an issue: https://github.com/treyhunner/countdown-cli/issues
 .. _pip: https://pip.pypa.io/

diff --git a/docs/images b/docs/images
@@ -0,0 +1 @@
+../images
diff --git a/images/1457.png b/images/1457.png
diff --git a/images/3253.png b/images/3253.png
diff --git a/images/python-morsels-logo.png b/images/python-morsels-logo.png
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "countdown-cli"
-version = "0.3.0"
+version = "1.0.0"
 description = "Terminal program to display countdown timer"
 authors = ["Trey Hunner <trey@treyhunner.com>"]
 license = "MIT"