Minor updates to documentation

README.md

@@ -12,27 +12,37 @@
 A GitHub template with my python package configurations.
 
 ## GitHub repository settings
+The following settings are enabled in my repository settings:
+
 Code/About:
 - Releases
 
+<br>
+
 General/Features:
 - Issues
 - Preserve this repository
 
+<br>
+
 General/Pull Requests:
 - Allow merge commits
 - Allow squash merging
 - Allow rebase merging
 - Automatically delete head branches
 
+<br>
+
 Branches/Branch protection rules:\
-`main`
-- Protect matching branches
-  - Require pull request reviews before merging
-  - Dismiss stale pull request approvals when new commits are pushed
-  - Require status checks to pass before merging
-    - `pre-commit.ci - pr`
-    - `tox / tox`
+`main`\
+Protect matching branches
+- Require pull request reviews before merging
+- Dismiss stale pull request approvals when new commits are pushed
+- Require status checks to pass before merging
+- `pre-commit.ci - pr`
+- `tox / tox`
+
+<br>
 
 Environments:\
 `pypi`
@@ -42,11 +52,10 @@ Environments:\
 - Allow administrators to bypass configured protection rules
 
 ## Setup PyPi trusted publishing
-
 [PyPi publishing settings](https://pypi.org/manage/account/publishing/)
 
 Add a new pending publisher:
 - PyPi Project Name: `python-package-template-pypi` (has to match the project name in `pyproject.toml`)
 - Owner: `daniel-mizsak`
-- Repository name: `https://github.com/daniel-mizsak/python-package-template`
+- Repository name: `python-package-template`
 - Workflow name: `release.yml`

docs/add_five.rst

@@ -1,6 +1,19 @@
 Add five
 ========
 
+Example call
+------------
+
+To increment the value of a number by five, use the `add_five` function.
+
+.. code-block:: python
+
+    from python_package_template import add_five
+
+    print(add_five(8))
+
+
 Description of the `add_five` function:
+---------------------------------------
 
 .. autofunction:: python_package_template.main.add_five

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "hatchling.build"
 # Project Metadata
 [project]
 name = "python-package-template-pypi" # Name has to be unique on pypi.
-version = "0.0.1"
+version = "0.0.2"
 description = "A github template with my python package configurations."
 readme = "README.md"
 requires-python = ">=3.12"