diff --git a/README.md b/README.md index 5084899..4e7819a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Vault API +![Vault API hero banner](docs/assets/vault-api-hero.svg) + [![CI](https://github.com/MugdhoAI/vault-api/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MugdhoAI/vault-api/actions/workflows/ci.yml) [![CodeQL](https://github.com/MugdhoAI/vault-api/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/MugdhoAI/vault-api/actions/workflows/codeql.yml) diff --git a/docs/assets/vault-api-hero.svg b/docs/assets/vault-api-hero.svg new file mode 100644 index 0000000..2eb9621 --- /dev/null +++ b/docs/assets/vault-api-hero.svg @@ -0,0 +1,60 @@ + +Vault API — Store Secrets. Keep Control. +A dark blue technical banner for a learning-focused secret vault API, with a vault mascot, PostgreSQL storage, API request examples, and security features. + + + + + + + + + +A SECURE SECRET VAULT API +vault-api +Store Secrets. Keep Control. +A learning-focused secret vault API with secure authentication, +encrypted secret storage, and PostgreSQL persistence. +FASTAPI • POSTGRESQL • JWT • ARGON2 • FERNET + + + + + + + + + + + VAULT / LOCKED + + + + + + + POST /secrets + { "name": "api_key", + "value": "••••••••", + "owner": "user" } + + + + + ✓ JWT Authentication✓ Argon2 Password Hashing✓ Fernet Encryption✓ PostgreSQL Storage + + + + + + + PostgreSQL + + + + + + + ENCRYPTED AT REST + + \ No newline at end of file