From 75da4da0f8c3685a241c38f2f8f7735751491161 Mon Sep 17 00:00:00 2001 From: Mathias Ertl Date: Thu, 26 Dec 2024 12:46:54 +0100 Subject: [PATCH] harmonize descriptions --- README.md | 22 ++++++++++------------ docs/source/changelog/TBR_2.1.0.rst | 2 +- docs/source/deprecation.rst | 2 +- docs/source/intro.rst | 5 ++--- 4 files changed, 14 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1d11476c9..eebbb5b32 100644 --- a/README.md +++ b/README.md @@ -10,24 +10,22 @@ ## About -**django-ca** is a small project to manage TLS certificate authorities and easily issue -certificates. It is based on [cryptography](https://cryptography.io/) and -[Django](https://www.djangoproject.com/>). It can be used as an app in an existing Django project -or stand-alone with the basic project included. Certificates can be managed through Django's admin -interface or via `manage.py` commands - so no webserver is needed, if you’re happy with the -command-line. +**django-ca** is a tool to manage TLS certificate authorities and easily issue and revoke certificates. It is +based on [cryptography](https://cryptography.io/) and [Django](https://www.djangoproject.com/>). It can be used as an app in an existing Django project or +stand-alone with the basic project included. Certificates can be managed through Django's admin interface or +via `manage.py` commands - so no webserver is needed, if you’re happy with the command-line. Documentation is available at https://django-ca.readthedocs.org/. ## Features 1. Set up a secure local certificate authority in just a few minutes. -2. Certificate revocation via CRLs and OCSP. -3. Certificate issuance via ACMEv2, command line or web interface. -4. **Preliminary** support for hardware security modules (HSMs). -4. Management via command line and/or via Django's admin interface. -5. Get email notifications about certificates about to expire. -6. Written in Python 3.9+, Django 4.2+ and cryptography 43+. +2. Certificate issuance via ACMEv2, REST API, command line or web interface. +3. Certificate revocation via CRLs and OCSP. +4. Private key storage on the file system, in the database or in a Hardware Security Module (HSM). +5. Management via command line and/or via Django's admin interface. +6. Get email notifications about certificates about to expire. +7. Written in Python 3.9+, Django 4.2+ and cryptography 43+. Please see https://django-ca.readthedocs.org for more extensive documentation. diff --git a/docs/source/changelog/TBR_2.1.0.rst b/docs/source/changelog/TBR_2.1.0.rst index 5844e6eec..0cd1adfd6 100644 --- a/docs/source/changelog/TBR_2.1.0.rst +++ b/docs/source/changelog/TBR_2.1.0.rst @@ -126,4 +126,4 @@ Deprecation notices Please also see the :doc:`deprecation timeline ` for previous deprecation notices. * This will be the last release to support ``django~=5.0.0``, ``cryptography~=43.0`` and ``pydantic~=2.9.0``. -* Support for Python 3.9 will be dropped in ``django-ca==2.3.0``. +* Support for Python 3.9 and ``django~=4.2.0`` will be dropped in ``django-ca==2.3.0``. diff --git a/docs/source/deprecation.rst b/docs/source/deprecation.rst index aa3026c13..9ae9c6f83 100644 --- a/docs/source/deprecation.rst +++ b/docs/source/deprecation.rst @@ -9,7 +9,7 @@ Deprecation timeline Dependencies ============ -* Drop support for Python 3.9. +* Drop support for Python 3.9 and ``django~=4.2.0`` Command-line ============ diff --git a/docs/source/intro.rst b/docs/source/intro.rst index f511f27ae..b094fd0c3 100644 --- a/docs/source/intro.rst +++ b/docs/source/intro.rst @@ -7,12 +7,11 @@ command-line. Features: #. Set up a secure local certificate authority in just a few minutes. +#. Certificate issuance via ACMEv2, REST API, command line or web interface. #. Certificate revocation via CRLs and OCSP. -#. Certificate issuance via ACMEv2, command line, web interface or REST API. -#. **Preliminary** support for hardware security modules (HSMs). +#. Private key storage on the file system, in the database or in a Hardware Security Module (HSM). #. Management via command line and/or via Django's admin interface. #. Get email notifications about certificates about to expire. #. Written in Python 3.9+, Django 4.2+ and cryptography 43+. -#. Written in Python 3.9+, Django 4.2+ and cryptography 43+. Please see https://django-ca.readthedocs.org for the most recent documentation.