Skip to content

Commit 290548c

Browse files
Update project title typography
1 parent 823d66b commit 290548c

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# djangorestframework-api-key
1+
# Django REST Framework API Key
22

33
API key permissions for the [Django REST Framework](https://www.django-rest-framework.org).
44

@@ -21,7 +21,7 @@ API key permissions for the [Django REST Framework](https://www.django-rest-fram
2121

2222
## Introduction
2323

24-
**`djangorestframework-api-key` is a powerful library for allowing server-side clients to safely use your API.** These clients are typically third-party backends and services (i.e. _machines_) which do not have a user account but still need to interact with your API in a secure way.
24+
**Django REST Framework API Key is a powerful library for allowing server-side clients to safely use your API.** These clients are typically third-party backends and services (i.e. _machines_) which do not have a user account but still need to interact with your API in a secure way.
2525

2626
### Features
2727

docs/guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Install from PyPI:
1010
pip install djangorestframework-api-key
1111
```
1212

13-
**Note**: `djangorestframework-api-key` requires Django REST Framework >= 3.8.
13+
**Note**: this package requires Python 3.5+, Django 2.0+ and Django REST Framework 3.8+.
1414

1515
### Project setup
1616

@@ -196,7 +196,7 @@ python manage.py migrate
196196
```
197197

198198
!!! important
199-
If `AbstractAPIKey` changes (e.g. because of an update to `djangorestframework-api-key`), you will need to **generate and apply migrations again** to account for these changes.
199+
If `AbstractAPIKey` changes (e.g. because of an update to Django REST Framework API Key), you will need to **generate and apply migrations again** to account for these changes.
200200

201201
#### Managers
202202

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<h1 style="margin-bottom: 0;">djangorestframework-api-key</h1>
2+
<h1 style="margin-bottom: 0;">Django REST Framework API Key</h1>
33
<p style="margin-top: 1em; margin-bottom: 2em; font-size: large;">
44
API key permissions for
55
<a href="https://www.django-rest-framework.org" alt="drf" target="_blank" rel="noreferrer">
@@ -27,7 +27,7 @@
2727

2828
## Introduction
2929

30-
**`djangorestframework-api-key` is a powerful library for allowing server-side clients to safely use your API.** These clients are typically third-party backends and services (i.e. _machines_) which do not have a user account but still need to interact with your API in a secure way.
30+
**Django REST Framework API Key is a powerful library for allowing server-side clients to safely use your API.** These clients are typically third-party backends and services (i.e. _machines_) which do not have a user account but still need to interact with your API in a secure way.
3131

3232
### Features
3333

docs/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The generated key that clients use to [make authorized requests](#making-authori
1414
- Only a hashed version is stored in the database. The hash is computed using the default password hasher. [^1]
1515
- The generated key is shown only once to the client upon API key creation.
1616

17-
[^1]: All hashers provided by Django should be supported. `djangorestframework-api-key` is tested against the [default list of `PASSWORD_HASHERS`](https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-PASSWORD_HASHERS). See also [How Django stores passwords](https://docs.djangoproject.com/en/2.2/topics/auth/passwords/#how-django-stores-passwords) for more information.
17+
[^1]: All hashers provided by Django should be supported. This package is tested against the [default list of `PASSWORD_HASHERS`](https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-PASSWORD_HASHERS). See also [How Django stores passwords](https://docs.djangoproject.com/en/2.2/topics/auth/passwords/#how-django-stores-passwords) for more information.
1818

1919
### Grant scheme
2020

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: djangorestframework-api-key
1+
site_name: Django REST Framework API Key
22
site_url: https://florimondmanca.github.io/djangorestframework-api-key
33
copyright: © 2018-present Florimond Manca
44
theme:

tests/project/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# project
22

3-
Test project for `djangorestframework-api-key`.
3+
Test project for Django REST Framework API Key.
44

55
## Usage
66

0 commit comments

Comments
 (0)