Commit 8e8b719

mo khan <mo@mokhan.ca>
2025-03-05 20:06:06
docs: update the README
1 parent e1fe97f
Changed files (1)
README.md
@@ -13,6 +13,27 @@ Below is a recording of a SAML based service provider initiated login, displayin
 
 ![SAML Login](./screencast.webm)
 
+## Getting Started
+
+1. Install tools:
+  ```sh
+  $ mise install
+  ```
+1. Add entries to `/etc/hosts`:
+  ```sh
+  $ tail -n3 /etc/hosts
+  127.0.0.1 api.example.com
+  127.0.0.1 idp.example.com
+  127.0.0.1 ui.example.com
+  ```
+1. Start servers:
+  ```sh
+  $ mage
+  ```
+1. Open browser to `http://ui.example.com:8080/saml/new` to start a new SAML
+   session. Or open `http://ui.example.com:8080/oidc/new` to start a new OIDC
+   session.
+
 ## Experiments
 
 ### Twirp + gRPC (AuthZ)