docs: housekeepign

Author: soopyc

.env.example

@@ -7,6 +7,7 @@ CACHING_METHOD="redis"  # can be "redis", "object" or "none". Defaults to object
 DATABASE_URL="postgresql://shortify:randompassword@localhost:5432/mydb?schema=public"
 
 # for simplicity we only support jwk for hmac algos.
+# (optional) use the provided utility (utils/jwt_generate.ts) to generate
 KEY_TYPE="jwk" # can be either "jwk" or "pkcs8". see jwt/jose rfc/docs for information.
 KEY_ALGO="EdDSA"
 JWT_KEY='{"kty":"OKP","crv":"Ed25519","x":"...","d":"..."}'

CHANGELOG.md

@@ -33,6 +33,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### ✨ Features
 - handle logging levels at run-time via the `DEBUG` environment variable (d930837)
 - automatically migrate the database on server hook setup (f3c5cbe)
+- jwk reading is now implemented, which enables the following POC (5cd756f)
+- POC link generation implemented (48e03ce)
+- (**server**) add jwt token checks (9b9ab43)
 
 ### 🧩 Components
 - removed essentially every overcomplicated component and modules (857ebc4)

README.md

@@ -4,5 +4,12 @@ Sleek self-hostable link shortening service. No analytics included!
 
 ## Deployment
 
-So far we only support postgresql databases. More options may be added later as
-we figure out a different way.
+> [!NOTE]
+>
+> We only support PostgreSQL databases.
+
+### Setup
+
+To generate required keys, you might want to use the provided utility available at `utils/jwt_generate.ts`. This tool requires Deno to run.
+
+As the project uses the standardized JSON Web Key format, it is possible to generate keys usable in this project without having to use the tool.