From 1500c90231b6679c7f8c1c1d270d5c4be515d180 Mon Sep 17 00:00:00 2001 From: Sergei Maertens Date: Tue, 26 Mar 2024 13:13:20 +0100 Subject: [PATCH] :pencil: Update docs to reflect the scope of the package --- README.rst | 10 +--------- docs/index.rst | 2 +- docs/quickstart.rst | 2 +- 3 files changed, 3 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index a5b68aa..460d948 100644 --- a/README.rst +++ b/README.rst @@ -23,7 +23,7 @@ Features ======== * Store services with their configuration in the database -* Integrate with OpenAPI 3.0 specifications +* Built in `ape-pie `_ API client adapter * NLX support * Declare data/domain objects as modern Python dataclasses @@ -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 ===== diff --git a/docs/index.rst b/docs/index.rst index 0afd92b..86bbd0c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,7 +11,7 @@ Features -------- * Store services with their configuration in the database -* Integrate with OpenAPI 3.0 specifications +* Built in `ape-pie `_ API client adapter * NLX support * Declare data/domain objects as modern Python dataclasses diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 5673cf8..5ef9fe1 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -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``: