Skip to content

Commit

Permalink
readme: update
Browse files Browse the repository at this point in the history
  • Loading branch information
Tatsh committed Sep 15, 2023
1 parent 30340fa commit a9e62c9
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,22 @@
pip install minchoc
```

In `settings.py`:

```python
INSTALLED_APPS = ['minchoc']
ALLOW_PACKAGE_DELETION = False
```

Add `path('', include('minchoc.urls'))` to your root `urls.py`. Example:

```python
from django.urls import include, path
urlpatterns = [
path('', include('minchoc.urls'))
]
```

A `DELETE` call to `/api/v2/package/<id>/<version>` will be denied even with authentication unless
`ALLOW_PACKAGE_DELETION` is set to `True`.

Expand All @@ -34,3 +45,6 @@ As administrator:
choco source add -s 'https://your-host/url-prefix'
choco apikey add -s 'https://your-host/url-prefix' -k 'your-key'
```

On non-Windows platforms, you can use my [pychoco](https://github.com/Tatsh/pychoco) package, which
also supports the above commands.

0 comments on commit a9e62c9

Please sign in to comment.