Skip to content

Commit

Permalink
📝 Update docs to reflect the scope of the package
Browse files Browse the repository at this point in the history
  • Loading branch information
sergei-maertens committed Mar 26, 2024
1 parent 536936d commit 1500c90
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 11 deletions.
10 changes: 1 addition & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Features
========

* Store services with their configuration in the database
* Integrate with OpenAPI 3.0 specifications
* Built in `ape-pie <https://pypi.org/project/ape-pie/>`_ API client adapter
* NLX support
* Declare data/domain objects as modern Python dataclasses

Expand All @@ -48,14 +48,6 @@ Install
2. Add ``zgw_consumers`` and ``simple_certmanager`` to the ``INSTALLED_APPS`` setting.

3. Optionally override ``ZGW_CONSUMERS_CLIENT_CLASS`` to a custom client class.

4. Optionally specify ``ZGW_CONSUMERS_OAS_CACHE`` to point to a separate django cache.
Defaults to ``django.core.cache.DEFAULT_CACHE_ALIAS``, which is ``default`` in
practice. For performance reasons we highly recommend to use a real cache backend
like Redis or Memcache.


Usage
=====

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Features
--------

* Store services with their configuration in the database
* Integrate with OpenAPI 3.0 specifications
* Built in `ape-pie <https://pypi.org/project/ape-pie/>`_ API client adapter
* NLX support
* Declare data/domain objects as modern Python dataclasses

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Installation

**Requirements**

* Python 3.7 or newer
* Python 3.10 or newer
* Django 3.2+

1. Install from PyPI using ``pip``:
Expand Down

0 comments on commit 1500c90

Please sign in to comment.