commit 341c96f2e2038b0052520fe9812284d677e1ec6c
Author: Pelagic <support@starfields.gr>
Date:   Wed Aug 23 04:36:09 2023 +0300

    Created the README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc9583e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+This repository holds the django library that StarFields uses for the django-rest-framework generic views.
+
+# Differences with the DRF generic views
+
+It changes the generic lifecycles of all the CRUD operations to fit within them automated caching functionality. Caching and deleting cache keys is handled by the library in a way that the cache keys have no duplicates. The generic views offered include single item CRUD and list-based CRUD.
+To manage automated caching this the library replaces (and appends to) the DRF filters. These filters need a get_unique_dict method in order to avoid the duplicate cache keys problem.