diff --git a/.gitignore b/.gitignore
index f1610f3..cc68107 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
 /target
+framework/target
 .env
 token.json
 token.txt
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7b7e777
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+
+Web API experiment with actix and surrealDB.
+
+Generate doc: `cargo doc --workspace --no-deps --open`
+
+- Oauth2/OpenID JWT token for authentication provided by keycloak, with internal permissions in application
+- Easy-to-use cache wrapper, only implements Moka but can be easily extended. [More](framework/src/cache)
+- Derive filter structs for surrealDB queries. [More](framework/macros/)
+- CRUD API with filtering, and dynamic ID (user can be referenced by either id, oidc_id, or username)