Skip to content

Commit

Permalink
docs: tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Kikobeats committed Jan 12, 2024
1 parent c8c10da commit de98a4a
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<img src="https://github.com/microlinkhq/cdn/raw/master/dist/logo/banner.png#gh-light-mode-only" alt="microlink logo">
<img src="https://github.com/microlinkhq/cdn/raw/master/dist/logo/banner-dark.png#gh-dark-mode-only" alt="microlink logo">
<img src="https://github.com/microlinkhq/openkey/raw/master/design/banner.jpg#gh-light-mode-only" alt="microlink logo">
<img src="https://github.com/microlinkhq/openkey/raw/master/design/banner.jpg#gh-dark-mode-only" alt="microlink logo">
<br>
<br>
</div>
Expand All @@ -11,6 +11,19 @@

> an AWS Gateway replacement for usage plans and keys for your HTTP API endpoint
## Concepts

<div align="center">
<img src="https://github.com/microlinkhq/openkey/raw/master/design/concepts.jpg#gh-light-mode-only" alt="microlink logo">
<img src="https://github.com/microlinkhq/openkey/raw/master/design/concepts.jpg#gh-dark-mode-only" alt="microlink logo">
</div>

**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?
Expand Down
Binary file added design/banner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added design/concepts.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added design/openkey.sketch
Binary file not shown.

0 comments on commit de98a4a

Please sign in to comment.