Merge pull request #115 from brionmario/update-docs

docs: update docs

Author: brionmario

.changeset/config.json

@@ -5,7 +5,7 @@
   "changelog": [
     "@changesets/changelog-github",
     {
-      "repo": "asgardeo/web-ui-sdks"
+      "repo": "asgardeo/javascript"
     }
   ],
   "commit": false,

.github/workflows/deploy-gh-pages.yml

@@ -44,7 +44,7 @@ jobs:
   deploy:
     environment:
       name: github-pages
-      url: "web-ui-sdks"
+      url: "javascript"
     runs-on: ubuntu-latest
     strategy:
       matrix:

CONTRIBUTING.md

@@ -73,13 +73,13 @@ Sorts JSON objects in alphabetical order.
 Replace `<github username>` with your own username.
 
 ```shell
-git clone https://github.com/<github username>/web-ui-sdks.git
+git clone https://github.com/<github username>/javascript.git
 ```
 
 3. Set the original repo as the upstream remote.
 
 ```shell
-git remote add upstream https://github.com/asgardeo/web-ui-sdks.git
+git remote add upstream https://github.com/asgardeo/javascript.git
 ```
 
 ## Setting up the Development Environment

README.md

@@ -1,30 +1,33 @@
 <p align="center" style="color: #343a40">
-  <img
-    src="https://github.com/asgardeo/web-ui-sdks/assets/25959096/ae77b70c-6570-40b1-a723-719abd0f7d02" alt="Asgardeo Logo" height="40" width="auto"
-  >
-  <h1 align="center">
-    Asgardeo JavaScript SDKs
-  </h1>
+  <img src="./docs/assets/images/banner.png" alt="Asgardeo Logo">
 </p>
-<p align="center" style="font-size: 1.2rem;">
-  JavaScript SDKs for building applications with <a href="https://wso2.com/asgardeo">Asgardeo</a>
+
+<p align="center" style="font-size: 1.2rem;font-weight: bold;">
+  <a href="https://asgardeo.io">Asgardeo</a> . <a href="https://wso2.com/asgardeo/docs/sdks">Documentation</a> . <a href="./CHANGELOG.md">Changelog</a>
 </p>
 
 <div align="center">
+  <a href="https://stackoverflow.com/questions/tagged/wso2is"><img src="https://img.shields.io/badge/Ask%20for%20help%20on-Stackoverflow-orange.svg" alt="Ask for help on Stackoverflow"></a>
+  <a href="https://discord.gg/wso2"><img src="https://img.shields.io/badge/Join%20us%20on-Discord-%23e01563.svg" alt="Join us on Discord"></a>
+  <a href="https://twitter.com/intent/follow?screen_name=wso2"><img src="https://img.shields.io/twitter/follow/wso2.svg?style=social&label=Follow" alt="Twitter"></a>
   <a href="./LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
-  <a href="https://github.com/asgardeo/web-ui-sdks/actions/workflows/release.yml"><img src="https://github.com/asgardeo/web-ui-sdks/actions/workflows/release.yml/badge.svg" alt="🚀 Release"></a>
-
-  <br>
-  <br>
+  <a href="https://github.com/asgardeo/javascript/actions/workflows/release.yml"><img src="https://github.com/asgardeo/javascript/actions/workflows/release.yml/badge.svg" alt="🚀 Release"></a>
 </div>
 
 <br>
 
-This repository contains the source code of JavaScript SDKs that can be used to build applications integrated with Asgardeo. If you have any questions, please reach out to us through one of the following channels:
+<p align="center" style="font-size: 1.2rem;">
+  Design secure, secure, and scalable applications with Asgardeo's JavaScript SDKs.
+</p>
+
+## 🚀 Get started with Asgardeo
+
+Follow these simple steps to get started with Asgardeo:
 
-[![Stackoverflow](https://img.shields.io/badge/Ask%20for%20help%20on-Stackoverflow-orange)](https://stackoverflow.com/questions/tagged/wso2is)
-[![Join the chat at https://discord.gg/wso2](https://img.shields.io/badge/Join%20us%20on-Discord-%23e01563.svg)](https://discord.gg/wso2)
-[![Twitter](https://img.shields.io/twitter/follow/wso2.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=wso2)
+1. Create an account in Asgardeo 👉 [Sign Up](https://asgardeo.io/signup?visitor_id=685a48bc57b3b5.46411343&utm_source=site&utm_medium=organic)
+2. Refer to our **Quick Start Guides** and get started in minutes.
+  - `React Quick Start`: [React Quick Start](https://wso2.com/asgardeo/docs/quick-starts/react/)
+  - `Next.js Quick Start`: [Next.js Quick Start](https://wso2.com/asgardeo/docs/quick-starts/nextjs/)
 
 ## Packages
 
@@ -37,15 +40,19 @@ This repository contains the source code of JavaScript SDKs that can be used to
 | [![@asgardeo/express](https://img.shields.io/npm/v/@asgardeo/express?color=%23339933&label=%40asgardeo%2Fexpress&logo=express)](./packages/express/) | Express.js SDK for server-side integration |
 | [![@asgardeo/nuxt](https://img.shields.io/npm/v/@asgardeo/nuxt?color=%2300DC82&label=%40asgardeo%2Fnuxt&logo=nuxt)](./packages/nuxt/) | Nuxt.js SDK for building applications with Asgardeo |
 | [![@asgardeo/react](https://img.shields.io/npm/v/@asgardeo/react?color=%2361DAFB&label=%40asgardeo%2Freact&logo=react)](./packages/react/) | React SDK for building applications with Asgardeo |
+| [![@asgardeo/react-router](https://img.shields.io/npm/v/@asgardeo/react-router?color=%2361DAFB&label=%40asgardeo%2Freact-router&logo=react-router)](./packages/react-router/) | Supplementary React Router bindings  |
 | [![@asgardeo/vue](https://img.shields.io/npm/v/@asgardeo/vue?color=%234FC08D&label=%40asgardeo%2Fvue&logo=vue.js)](./packages/vue/) | Vue.js SDK for building applications with Asgardeo |
 
 ## Contribute
+
 Please read [Contributing Guide](CONTRIBUTING.md) for details on how to contribute to Asgardeo JavaScript SDKs. Refer to [General Contribution Guidelines](http://wso2.github.io/) for details on our code of conduct, and the process for submitting pull requests to us.
 
 ### Reporting issues
-We encourage you to report issues, improvements, and feature requests creating [Github Issues](https://github.com/asgardeo/web-ui-sdks/issues).
+
+We encourage you to report issues, improvements, and feature requests creating [Github Issues](https://github.com/asgardeo/javascript/issues).
 
 **Important**: Please be advised that security issues MUST be reported to <a href="mailto:[email protected]">[email protected]</a>, not as GitHub issues, in order to reach the proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues.
 
 ## License
+
 This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.