convert README into basic docs site

Signed-off-by: Grant Ramsay <seapagan@gmail.com>

Author: seapagan

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to the FastAPI Template
+# Contributing to the Project
 
 Thank you for your interest in contributing to `fastapi-redis-cache-reborn`! We
 welcome all contributions, big or small.

TODO.md

@@ -1,5 +1,7 @@
 # TODO List
 
+## Existing Issues
+
 These below are from Issues or PRs in the original repository.
 
 - Add ability to manually expire a cache entry
@@ -8,6 +10,9 @@ These below are from Issues or PRs in the original repository.
   (<https://github.com/a-luna/fastapi-redis-cache/pull/66>)
 - Take a look at other issues in the original repository to see if any need to
   be added here.
+
+## New Ideas
+
 - add an option to the init function to disable logging of cache hits and
   misses. or only display these messages if a certain ENV variable is set/unset?
 - add an option to have a separate logging file for cache hits and misses?

docs/changelog.md

@@ -0,0 +1 @@
+--8<-- "CHANGELOG.md"

docs/contributing.md

@@ -0,0 +1 @@
+--8<-- "CONTRIBUTING.md"

docs/index.md

@@ -1,17 +1,39 @@
-# Welcome to MkDocs
+# FastAPI-Redis-Cache-Reborn
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+## Introduction
 
-## Commands
+A simple and robust caching solution for FastAPI that interprets request header
+values and creates proper response header values (powered by Redis)
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
+This project is a continuation of
+[fastapi-redis-cache](https://github.com/a-luna/fastapi-redis-cache){:target="_blank"}
+which seems to no longer be maintained and had fallen behind in both Redis and
+FastAPI versions. I decided to split this as a separate repository rather than a
+fork, since the original project has had no activity for a over three years.
 
-## Project layout
+Right now the code is basically the same as the original project, but I have
+updated the Package management system to use Poetry, the dependencies and the
+CI/CD pipeline, and added type-hinting. I've also merged some open PRs from the
+original project that fixed some issues.
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+See the TODO File file for a list of things I plan to do in the near future.
+
+The package still has the same interface and classes as the original. You will
+still import the package as `fastapi_redis_cache` in your code, the name has only
+changed on PyPI to avoid conflicts with the original package. This is to make it
+transparent to migrate to this version.
+
+!!! warning "Important"
+    It is important to make sure that the old package is uninstalled before
+    installing this one. The package name has changed, but the module name is
+    still `fastapi_redis_cache`. **The best way is to remove your old virtual
+    environment and run `poetry install` or `pip install` again**.
+
+## Features
+
+- Cache response data for async and non-async path operation functions.
+- Lifetime of cached data is configured separately for each API endpoint.
+- Requests with `Cache-Control` header containing `no-cache` or `no-store` are
+  handled correctly (all caching behavior is disabled).
+- Requests with `If-None-Match` header will receive a response with status `304 NOT
+  MODIFIED` if ETag for requested resource matches header value.

docs/installation.md

@@ -0,0 +1,16 @@
+# Installation
+
+To add `fastapi-redis-cache-reborn` to your project, you can use `poetry` or
+`pip`.
+
+if you are using `poetry` (recommended):
+
+```bash
+poetry add fastapi-redis-cache-reborn
+```
+
+Otherwise you can use `pip`:
+
+```bash
+pip install fastapi-redis-cache-reborn
+```

docs/license.md

@@ -0,0 +1,4 @@
+
+```
+--8<-- "LICENSE"
+```

docs/todo.md

@@ -0,0 +1 @@
+--8<-- "TODO.md"