Skip to content

Commit 68e7adb

Browse files
Update the readme for the example repo
1 parent e165875 commit 68e7adb

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

README.md

+4-15
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
1-
# django-commons-playground
2-
A sample project to test things out
1+
# Django Commons example repository
32

3+
This is an example repository for Django Commons. Some relevant areas to review are:
44

5-
## Running tests
6-
7-
```shell
8-
python -m unittest
9-
```
10-
11-
## Manually building and uploading
12-
13-
```shell
14-
python3 -m pip install -U twine build
15-
python3 -m build
16-
python3 -m twine upload --repository testpypi dist/*
17-
```
5+
- GitHub action ([release.yml](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)) for releasing to PyPI
6+
- [Documentation](docs/README.md)

0 commit comments

Comments
 (0)