update readme and docs

westerveltco · Nov 3, 2023 · 701e00d · 701e00d
1 parent 92507c0
commit 701e00d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
 # django-simple-nav
+
+[![PyPI](https://img.shields.io/pypi/v/django-simple-nav)](https://pypi.org/project/django-simple-nav/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-simple-nav)
+![Django Version](https://img.shields.io/badge/django-3.2%20%7C%204.1%20%7C%204.2-%2344B78B?labelColor=%23092E20)
+<!-- https://shields.io/badges -->
+<!-- django-3.2 | 4.1 | 4.2-#44B78B -->
+<!-- labelColor=%23092E20 -->
+
+WIP
+
+## License
+
+`django-simple-nav` is licensed under the MIT license. See the [`LICENSE`](LICENSE) file for more information.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+```{include} ../README.md
+
+```