From 68e7adb561b27f7a5132753816a44d73afd0dbe4 Mon Sep 17 00:00:00 2001 From: Tim Schilling Date: Sun, 28 Apr 2024 20:33:50 -0500 Subject: [PATCH] Update the readme for the example repo --- README.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b95dce7..7277628 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,6 @@ -# django-commons-playground -A sample project to test things out +# Django Commons example repository +This is an example repository for Django Commons. Some relevant areas to review are: -## Running tests - -```shell -python -m unittest -``` - -## Manually building and uploading - -```shell -python3 -m pip install -U twine build -python3 -m build -python3 -m twine upload --repository testpypi dist/* -``` +- GitHub action ([release.yml](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)) for releasing to PyPI +- [Documentation](docs/README.md)