Skip to content

Commit

Permalink
docs: update README, now that apis-override-select2js is a dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
b1rger committed Nov 8, 2023
1 parent 697b4e1 commit f23e9eb
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,24 +86,15 @@ To use the APIS framework in your application, add the following APIS modules to

### Dependencies

```shell
poetry add git+https://github.com/acdh-oeaw/apis-override-select2js#v0.1.0
```

`apis_override_select2js` is a workaround for APIS' handling of autocomplete
forms. You will need it if you want to use autocomplete. Add it to your
`INSTALLED_APPS` and make sure it is listed at the beginning of the list, to
make sure the files shipped with it are served in precedence.

```python
"apis_override_select2js"
```


You will also need to add the following dependencies to
You will need to add the following dependencies to
[`INSTALLED_APPS`](https://docs.djangoproject.com/en/4.2/ref/settings/#installed-apps):

```python
# `apis_override_select2js` is a workaround for APIS' handling of autocomplete
# forms. It should be listed at the beginning of the list, to make sure the
# files shipped with it are served in precedence.
"apis_override_select2js",

# ui stuff
"crispy_forms",
"django_filters",
Expand Down

0 comments on commit f23e9eb

Please sign in to comment.