Skip to content

Commit

Permalink
Update the readme for the example repo
Browse files Browse the repository at this point in the history
  • Loading branch information
tim-schilling authored Apr 29, 2024
1 parent e165875 commit 68e7adb
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 68e7adb

Please sign in to comment.