Merge 84c49b7 into e6f20c0

QuangTung97 · Nov 28, 2023 · 10f799c · 10f799c
2 parents e6f20c0 + 84c49b7
commit 10f799c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,13 @@
 # A Caching Library with Strong Consistency
 
+[![memproxy-py](https://github.com/QuangTung97/memproxy-py/actions/workflows/go.yml/badge.svg)](https://github.com/QuangTung97/memproxy-py/actions/workflows/go.yml)
 [![Coverage Status](https://coveralls.io/repos/github/QuangTung97/memproxy-py/badge.svg?branch=master)](https://coveralls.io/github/QuangTung97/memproxy-py?branch=master)
+
+## Installation
+```shell
+pip install memproxy==0.3.0rc20
+```
+
+## Design Documentation
+1. [Overview](docs/overview.md)
+
diff --git a/docs/images/cache-aside.png b/docs/images/cache-aside.png
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,5 @@
+# Architecture Overview
+This library developed using the **Cache-Aside Pattern**, with basic steps:
+1. Data is first get from Cache Server (Redis)
+2. If Data is Existed on the Cache => Returns to Client
+3. If Data is NOT Existed => Get From DB => Set Back to Redis => Returns to Client