diff --git a/README.md b/README.md index acaf47b..cf7aaf5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- microlink logo - microlink logo + microlink logo + microlink logo

@@ -11,6 +11,19 @@ > an AWS Gateway replacement for usage plans and keys for your HTTP API endpoint +## Concepts + +
+ microlink logo + microlink logo +
+ +**openkey** orbits around three concepts: + +- **Plans**: Represents the quota, rate limit, and throttle information specified as a plan. +- **Keys**: Represents the credentials used during the authentication step and which plan is associated. +- **Usage**: Keep track of how much plan is available and consumed with the associated key. + ## FAQ ### Why? diff --git a/design/banner.jpg b/design/banner.jpg new file mode 100644 index 0000000..01d1bfb Binary files /dev/null and b/design/banner.jpg differ diff --git a/design/concepts.jpg b/design/concepts.jpg new file mode 100644 index 0000000..293675c Binary files /dev/null and b/design/concepts.jpg differ diff --git a/design/openkey.sketch b/design/openkey.sketch new file mode 100644 index 0000000..eb2b67c Binary files /dev/null and b/design/openkey.sketch differ