feat: sdk docs

docs/docs/home/01-welcome.md

@@ -9,19 +9,19 @@ slug: /
 
 Justaname is your powerful ally for seamless integration of Ethereum Name Service (ENS) subnames into your applications and projects. Our platform offers a developer-friendly approach to creating, managing, and resolving ENS subnames with unparalleled efficiency and scalability.
 
-## **Key Advantages of Using Justaname:**
+## **Key Advantages of Using Justaname**:
 
-- **Scale Effortlessly:** Handle large-scale subname operations with ease, thanks to our offchain resolver that reduces on-chain transactions.
-- **Boost User Experience:** Provide a fast and responsive experience with rapid subname resolution, enhancing interactions with your dApps or services.
-- **Minimize Costs:** Significantly lower gas fees and transaction costs associated with ENS management.
-- **Integrate with Ease:** Our intuitive API and comprehensive documentation make integration into your project a breeze.
+- **Scale Effortlessly**: Handle large-scale subname operations with ease, thanks to our offchain resolver that reduces on-chain transactions.
+- **Boost User Experience**: Provide a fast and responsive experience with rapid subname resolution, enhancing interactions with your dApps or services.
+- **Minimize Costs**: Significantly lower gas fees and transaction costs associated with ENS management.
+- **Integrate with Ease**: Our intuitive API and comprehensive documentation make integration into your project a breeze.
 
-## **Get Started:**
+## **Get Started**:
 
-1. **Dive into the Docs:** Explore our guides and API references to gain a solid understanding of Justaname's capabilities.
-2. **Create Your Account:** Set up your Justaname account to begin your journey.
-3. **Seamless Integration:** Use our powerful API to embed Justaname into your existing dApp or service.
-4. **Experience the Difference:** Enjoy cost-effective and scalable ENS subname management.
+1. **Dive into the Docs**: Explore our guides and API references to gain a solid understanding of Justaname's capabilities.
+2. **Create Your Account**: Set up your Justaname account to begin your journey.
+3. **Seamless Integration**: Use our powerful API to embed Justaname into your existing dApp or service.
+4. **Experience the Difference**: Enjoy cost-effective and scalable ENS subname management.
 
 ### **Questions? We're Here to Help!**
 

docs/docs/home/02-why-we-exist.md

@@ -13,18 +13,18 @@ ENS (Ethereum Name Service) was a significant improvement for interacting with b
 
 While ENS represented a significant advancement in the usability of blockchain addresses, certain challenges remain in achieving truly widespread adoption. These include:
 
-- **The Cost Barrier:** ENS names are tied to on-chain transactions on the Ethereum blockchain. These transactions incur costs (often referred to as "gas fees"), which can fluctuate significantly. During periods of high network activity, these fees can become quite expensive, making it difficult for newcomers or those with limited resources to acquire and manage an ENS name.
-- **Technical Hurdles:** Though using ENS offers a more user-friendly experience compared to wallet addresses, it still requires a degree of Web3 familiarity. Users need to understand concepts like wallets, transactions, and potentially even interact with decentralized exchanges to purchase the necessary cryptocurrency.
-- **Lack of Awareness:** Despite its advantages, ENS might  not be widely known by mainstream users or those new to the blockchain space. Raising awareness and educating potential users about the benefits of human-readable blockchain names would be crucial for broader adoption.
+- **The Cost Barrier**: ENS names are tied to on-chain transactions on the Ethereum blockchain. These transactions incur costs (often referred to as "gas fees"), which can fluctuate significantly. During periods of high network activity, these fees can become quite expensive, making it difficult for newcomers or those with limited resources to acquire and manage an ENS name.
+- **Technical Hurdles**: Though using ENS offers a more user-friendly experience compared to wallet addresses, it still requires a degree of Web3 familiarity. Users need to understand concepts like wallets, transactions, and potentially even interact with decentralized exchanges to purchase the necessary cryptocurrency.
+- **Lack of Awareness**: Despite its advantages, ENS might  not be widely known by mainstream users or those new to the blockchain space. Raising awareness and educating potential users about the benefits of human-readable blockchain names would be crucial for broader adoption.
 
 ## JustaName: Bridging the Gap
 
 JustaName was created to address these challenges by providing an off-chain solution that extends the functionality of ENS. We "productise" ENS by offering a similar feature set with a focus on abstraction from the underlying gas costs.
 Here's how JustaName makes interacting with the blockchain more accessible:
 
-- **Gasless Experience:** By handling transactions off-chain, JustaName abstracts away the gas fees associated with ENS interactions.
-- **Simplified User Experience:** JustaName offers a user-friendly interface that removes the complexity of managing gas prices and limits. This allows users to focus on claiming and using their ENS names without worrying about the technical details.
-- **Increased Accessibility:** JustaName empowers a broader developer community to participate in the ENS ecosystem by providing user-friendly APIs and an SDK. These tools bypass the complexities of managing gas fees and blockchain interaction, making ENS integration significantly easier. This enhanced accessibility can fuel the growth and adoption of the decentralized web.
+- **Gasless Experience**: By handling transactions off-chain, JustaName abstracts away the gas fees associated with ENS interactions.
+- **Simplified User Experience**: JustaName offers a user-friendly interface that removes the complexity of managing gas prices and limits. This allows users to focus on claiming and using their ENS names without worrying about the technical details.
+- **Increased Accessibility**: JustaName empowers a broader developer community to participate in the ENS ecosystem by providing user-friendly APIs and an SDK. These tools bypass the complexities of managing gas fees and blockchain interaction, making ENS integration significantly easier. This enhanced accessibility can fuel the growth and adoption of the decentralized web.
 
 In essence, JustaName aims to bridge the gap between the potential of ENS and the user experience by providing a smoother, more cost-effective way to interact with the blockchain naming system.
 

docs/docs/home/03-the-app.md

@@ -11,18 +11,18 @@ slug: /the-app
 
 Welcome to the JustaName Web App, your central hub for managing your Web3 identity and interacting with the JustaName ecosystem. This user-friendly web application provides a comprehensive suite of features designed to empower you to:
 
-- **Manage Your Web3 Identity with Ease:**
-    - **Claim and Manage Your justan.id:** Secure your free, permanent justan.id – your unique identifier within the JustaName network.
-    - **Effortlessly Manage Your ENS Subnames:** The JustaName Web App serves as your central command center for all your ENS subnames. Add, remove, and update them effortlessly, all within a single, intuitive interface.
-    - **Seamless Profile Data Updates:** Keep your profile information up-to-date. Edit your details, customize your profile, and ensure your online presence accurately reflects who you are.
-- **Join Thriving Communities:**
-    - **Invitation Central:** Receive and accept invitations from businesses and communities to claim new subnames. Become part of the groups and projects that resonate with you.
-    - **Community Exploration:** Discover a diverse landscape of communities thriving on the JustaName network. Explore their offerings, values, and see if there's a perfect fit for you.
-    - **Your Community Dashboard:** Keep track of the communities you've joined and the subnames you hold within them. See your place within the JustaName ecosystem and explore the connections you've built.
-- **Connect and Engage:**
-    - **User Profiles:** View other users' profiles and see their associated subnames. Gain transparency within the network and connect with like-minded individuals.
-    - **Secure Web3 Messaging:** The JustaName Web App integrates the XMTP protocol, enabling private and secure conversations with other users. Foster meaningful connections and engage in discussions within a safe environment.
-- **Personalize Your Web3 Experience:**
-    - **Primary Name Control:** Choose the subname that best represents you as your primary name. This name will be displayed across applications and services integrated with JustaName, ensuring a consistent and recognizable online identity.
+- **Manage Your Web3 Identity with Ease**:
+    - **Claim and Manage Your justan.id**: Secure your free, permanent justan.id – your unique identifier within the JustaName network.
+    - **Effortlessly Manage Your ENS Subnames**: The JustaName Web App serves as your central command center for all your ENS subnames. Add, remove, and update them effortlessly, all within a single, intuitive interface.
+    - **Seamless Profile Data Updates**: Keep your profile information up-to-date. Edit your details, customize your profile, and ensure your online presence accurately reflects who you are.
+- **Join Thriving Communities**:
+    - **Invitation Central**: Receive and accept invitations from businesses and communities to claim new subnames. Become part of the groups and projects that resonate with you.
+    - **Community Exploration**: Discover a diverse landscape of communities thriving on the JustaName network. Explore their offerings, values, and see if there's a perfect fit for you.
+    - **Your Community Dashboard**: Keep track of the communities you've joined and the subnames you hold within them. See your place within the JustaName ecosystem and explore the connections you've built.
+- **Connect and Engage**:
+    - **User Profiles**: View other users' profiles and see their associated subnames. Gain transparency within the network and connect with like-minded individuals.
+    - **Secure Web3 Messaging**: The JustaName Web App integrates the XMTP protocol, enabling private and secure conversations with other users. Foster meaningful connections and engage in discussions within a safe environment.
+- **Personalize Your Web3 Experience**:
+    - **Primary Name Control**: Choose the subname that best represents you as your primary name. This name will be displayed across applications and services integrated with JustaName, ensuring a consistent and recognizable online identity.
 
 **Experience the ease of Web3 identity management with the JustaName App.**

docs/docs/home/04-admin-dashboard.md

@@ -9,25 +9,25 @@ slug: /admin-dashboard
 
 The JustaName Dashboard is a powerful toolkit designed to streamline Web3 identity creation and management for both businesses and individuals. Whether you're integrating JustaName into your business applications or exploring your personal Web3 journey, the Dashboard offers intuitive features to guide you.
 
-### **Simplified ENS and DNS Domain Setup in 3 Steps:**
+### **Simplified ENS and DNS Domain Setup in 3 Steps**:
 
-1. **Connect:** Link your existing ENS or DNS domain, or register a new one directly through the Dashboard (coming soon).
-2. **Configure:** Customise your domain settings to align with your brand or personal identity.
-3. **Activate:** Generate your API key and get ready to leverage the power of JustaName through our SDK!
+1. **Connect**: Link your existing ENS or DNS domain, or register a new one directly through the Dashboard (coming soon).
+2. **Configure**: Customise your domain settings to align with your brand or personal identity.
+3. **Activate**: Generate your API key and get ready to leverage the power of JustaName through our SDK!
 
 ### **Free Tier: Because Web3 Identity Should Be Accessible**
 
-- **Individuals:** Set up your ENS domain and benefit from free data updates, ensuring your information stays current within your ENS profile.
-- **Businesses and Individuals:** Benefit from 30 free subnames per ENS domain, offering ample opportunity for experimentation and community building.
+- **Individuals**: Set up your ENS domain and benefit from free data updates, ensuring your information stays current within your ENS profile.
+- **Businesses and Individuals**: Benefit from 30 free subnames per ENS domain, offering ample opportunity for experimentation and community building.
 
 ### **Features for Businesses: Supercharge Your Web3 Applications**
-- **Seamless API Integration:** Our robust API and SDK make it simple to embed JustaName's subname issuance capabilities directly into your applications, products, or services.
-- **Affordable Subname Issuance:** Provide your user base with personalized and recognizable Web3 identifiers without the prohibitive costs associated with traditional methods.
-- **Subname Reservation:** Secure the perfect subnames for your users before they're taken! Easily pre-register subnames to streamline future distribution.
-- **Comprehensive Subname View:** Monitor and manage all of your users' subnames from a single, easy-to-use interface.
-- **Profile Management:** Keep your profile updated and accurate. Control the way your business presents itself within the JustaName ecosystem.
-- **Workspace Collaboration:** Invite team members to your workspace, enabling efficient collaboration and management of multiple ENS domains.
-- **Testnet Environment:**  Test your JustaName integration in a safe sandbox environment before deploying to production. This ensures a smooth and reliable developer experience.
+- **Seamless API Integration**: Our robust API and SDK make it simple to embed JustaName's subname issuance capabilities directly into your applications, products, or services.
+- **Affordable Subname Issuance**: Provide your user base with personalized and recognizable Web3 identifiers without the prohibitive costs associated with traditional methods.
+- **Subname Reservation**: Secure the perfect subnames for your users before they're taken! Easily pre-register subnames to streamline future distribution.
+- **Comprehensive Subname View**: Monitor and manage all of your users' subnames from a single, easy-to-use interface.
+- **Profile Management**: Keep your profile updated and accurate. Control the way your business presents itself within the JustaName ecosystem.
+- **Workspace Collaboration**: Invite team members to your workspace, enabling efficient collaboration and management of multiple ENS domains.
+- **Testnet Environment**:  Test your JustaName integration in a safe sandbox environment before deploying to production. This ensures a smooth and reliable developer experience.
 
 ### Plan Flexibility
 

docs/docs/home/use-cases/06-gaming.md

@@ -9,7 +9,7 @@ description: Seamless Cross-Platform Identity Management for Gamers and Metavers
 ## The Problem: Fragmented Identities and Limited Interoperability
 The world of gaming and metaverses is rapidly expanding, yet players face limitations that hinder a seamless experience:
 
-* **Disjointed Usernames:** Gamers are forced to create separate usernames for each game or metaverse they join, leading to fragmented reputations and online presence.
+* **Disjointed Usernames**: Gamers are forced to create separate usernames for each game or metaverse they join, leading to fragmented reputations and online presence.
 * **Trapped Assets**: Achievements, items, and in-game currency earned on one platform often can't be shared or recognized in others.
 * **Difficult Cross-Game Connections**: Building communities and finding friends across games is complicated due to separate identities.
 

docs/docs/sdk/01-get-started.mdx

@@ -0,0 +1,51 @@
+---
+id: get-started
+title: Get Started
+sidebar_label: Get Started
+slug: /sdk
+---
+
+# Getting Started with JustaName
+
+JustaName provides a streamlined solution for managing digital identities within the Web3 space. It leverages the Ethereum Name Service (ENS) and Cross-Chain Interoperability Protocol (CCIP) to simplify blockchain addresses with human-readable subnames.
+
+## Key Features
+
+- **User-Friendly Addresses**: Replace complex blockchain addresses with memorable subnames (e.g., 'yourname.eth').
+- **Cross-Chain Compatibility**: Support for various blockchain networks.
+
+## Benefits of JustaName SDKs
+
+- **Simplified Development**: Pre-built components and abstractions within the SDKs help you save time and effort when implementing JustaName features.
+- **Enhanced User Experience**: Create intuitive interfaces for managing subnames and interacting with the JustaName system, improving overall usability.
+- **Robust Functionality**: Access a wide range of features, including subname creation, resolution, SIWE authentication, and more.
+- **Cross-Platform Support**: Build applications that seamlessly work across different blockchains.
+
+
+# Setup Options
+
+## Quick Start with create-justaname-app
+
+Prerequisites: Node.js and npm (or yarn), and an api key from the [JustaName Admin Portal](https://admin.justaname.id).
+Installation:
+```bash npm2yarn
+npm install -g create-justaname-app@latest
+```
+Project Creation:
+```bash
+npx create-justaname-app@latest
+```
+<img src="/img/create-justaname-app.png" alt="create-justaname-app" />
+
+
+## Manual Setup
+
+Prerequisites: Node.js and npm (or yarn), and an api key from the [JustaName Admin Portal](https://admin.justaname.id).
+
+Install Dependencies:
+```bash npm2yarn
+npm install @justaname.id/sdk @justaname.id/react
+```
+(Include React SDK if needed)
+
+Integrate SDKs: Import and configure the SDKs within your existing project structure.

docs/docs/sdk/core/sdk-api/classes/JustaName.md

@@ -51,7 +51,7 @@ const configuration = {
 
 #### Defined in
 
-[lib/justaname/index.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/3b7cbff/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L40)
+[lib/justaname/index.ts:40](https://github.com/JustaName-id/JustaName-sdk/blob/d3b91b5/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L40)
 
 ## Properties
 
@@ -61,7 +61,7 @@ const configuration = {
 
 #### Defined in
 
-[lib/justaname/index.ts:30](https://github.com/JustaName-id/JustaName-sdk/blob/3b7cbff/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L30)
+[lib/justaname/index.ts:30](https://github.com/JustaName-id/JustaName-sdk/blob/d3b91b5/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L30)
 
 ___
 
@@ -77,7 +77,7 @@ JustaName
 
 #### Defined in
 
-[lib/justaname/index.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/3b7cbff/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L38)
+[lib/justaname/index.ts:38](https://github.com/JustaName-id/JustaName-sdk/blob/d3b91b5/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L38)
 
 ## Methods
 
@@ -105,7 +105,7 @@ Checks if the API key is present.
 
 #### Defined in
 
-[lib/justaname/index.ts:73](https://github.com/JustaName-id/JustaName-sdk/blob/3b7cbff/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L73)
+[lib/justaname/index.ts:73](https://github.com/JustaName-id/JustaName-sdk/blob/d3b91b5/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L73)
 
 ___
 
@@ -137,7 +137,7 @@ Checks the health of the API.
 
 #### Defined in
 
-[lib/justaname/index.ts:87](https://github.com/JustaName-id/JustaName-sdk/blob/3b7cbff/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L87)
+[lib/justaname/index.ts:87](https://github.com/JustaName-id/JustaName-sdk/blob/d3b91b5/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L87)
 
 ___
 
@@ -167,4 +167,4 @@ Initializes the JustaName SDK.
 
 #### Defined in
 
-[lib/justaname/index.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/3b7cbff/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L56)
+[lib/justaname/index.ts:56](https://github.com/JustaName-id/JustaName-sdk/blob/d3b91b5/packages/@justaname.id/sdk/src/lib/justaname/index.ts#L56)