StarFields/starfields-drf-generics
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

Formatting for code blocks in README.md

Browse Source
This commit is contained in:
Pelagic
2023-09-12 13:40:39 +03:00
parent 986d4302a7
commit 71573ca44e
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -7,12 +7,15 @@ To manage automated caching this the library replaces (and appends to) the DRF f
# Usage # Usage
### Ensure that the module is in the INSTALLED_APPS in settings.py: ### Ensure that the module is in the INSTALLED_APPS in settings.py:
```python
INSTALLED_APPS = [ INSTALLED_APPS = [
... ...
'starfields_drf_generics', 'starfields_drf_generics',
] ]
```
### Making views in views.py: ### Making views in views.py:
```python
from starfields_drf_generics import generics from starfields_drf_generics import generics
from starfields_drf_generics import filters as libfilters from starfields_drf_generics import filters as libfilters
@@ -50,6 +53,7 @@ class SearchView(generics.CachedListRetrieveAPIView):
) )
logger = logger logger = logger
cache = cache cache = cache
```
### New class attributes that are used ### New class attributes that are used
cache_prefix: defines the prefix that the module will use when saving values in the cache cache_prefix: defines the prefix that the module will use when saving values in the cache