diff --git a/README.md b/README.md index 1ac97e1..e684e33 100644 --- 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. +

+ +

+ +- 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 + +

+ +

+ +- 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. + +

+ +

+ +- Once your email is verified and you login you will see the Nebari landing page. + +

+ +

+ ## 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 new file mode 100644 index 0000000..67a6f2c Binary files /dev/null and b/images/account-confirm.png differ diff --git a/images/account-register.png b/images/account-register.png new file mode 100644 index 0000000..2521c32 Binary files /dev/null and b/images/account-register.png differ diff --git a/images/nebari-splash.png b/images/nebari-splash.png new file mode 100644 index 0000000..36f3952 Binary files /dev/null and b/images/nebari-splash.png differ diff --git a/images/verify-email.png b/images/verify-email.png new file mode 100644 index 0000000..67ff303 Binary files /dev/null and b/images/verify-email.png differ diff --git a/images/welcome-nebari.png b/images/welcome-nebari.png new file mode 100644 index 0000000..a595fa4 Binary files /dev/null and b/images/welcome-nebari.png differ