Merge pull request #9 from MetroStar/updated-docs

Updated docs
nebari-dev · May 7, 2024 · 364df42 · 364df42
2 parents 7b2c5f3 + 05fba93
commit 364df42
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,36 @@
 pip install nebari-plugin-self-registration
 ```
 
+## User Registration via this extension
+Steps for self registration:
+
+- Navigate to your Nebari domain.
+<p align="center">
+  <img src="images/welcome-nebari.png" />
+</p>
+
+- You may have a hyperlink on the welcome page that takes you to the user registration form. If not, navigate to https://{your-domain-name}/registration
+
+<p align="center">
+  <img src="images/account-register.png" width="400"/>
+</p>
+
+- Enter your email address and coupon code.
+
+- After clicking "Submit" follow the instructions to login with your temporary password. By clicking the "Login" button, it will take you to a Welcome page where you can sign in with Keycloak.
+
+- After you have entered a new password, you will receive a verification email.  
+
+<p align="center">
+  <img src="images/account-confirm.png" />
+</p>
+
+- Once your email is verified and you login you will see the Nebari landing page.
+
+<p align="center">
+  <img src="images/nebari-splash.png" />
+</p>
+
 ## License
 
 `nebari-plugin-self-registration` is distributed under the terms of the [Apache](./LICENSE.md) license.
diff --git a/images/account-confirm.png b/images/account-confirm.png
diff --git a/images/account-register.png b/images/account-register.png
diff --git a/images/nebari-splash.png b/images/nebari-splash.png
diff --git a/images/verify-email.png b/images/verify-email.png
diff --git a/images/welcome-nebari.png b/images/welcome-nebari.png