feat: [sc-26178] Create readme for NameAI SDK (#578)

* create readme for nameai-sdk; add license

* extend response example

Author: Byczong

packages/nameai-sdk/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 NameHash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/nameai-sdk/README.md

@@ -0,0 +1,127 @@
+# NameAI SDK
+
+![NPM Version](https://img.shields.io/npm/v/@namehash/nameai)
+
+[NameAI](https://nameai.dev) extends [NameGuard](https://nameguard.io) with sophisticated natural language processing capabilities to help evaluate and understand Ethereum Name Service (ENS) names.
+
+[NameGuard](https://nameguard.io) is designed to inspect and prevent malicious use of ENS names by providing comprehensive security checks. See the [NameGuard SDK documentation](../nameguard-sdk/README.md) for details about the base security features.
+
+⚠️ **This SDK is BETA. Things will change based on the community feedback.**
+
+## Features
+
+Additional features provided by NameAI on top of NameGuard:
+- **Natural Language Processing**: Evaluate how well ENS names represent meaningful words or phrases
+- **Tokenization**: Break down names into meaningful word components with probability scoring
+- **Purity Scoring**: Assess the cleanliness and quality of ENS names
+- **Sort Scoring**: Get relative ranking scores for ENS names
+
+The `@namehash/nameai` SDK provides full type-safety when working with the NameAI API.
+
+## Install
+
+Install NameAI via npm, yarn or pnpm:
+
+```bash
+npm install @namehash/nameai
+```
+
+## Usage
+
+Import `nameai`:
+
+```ts
+import { nameai } from "@namehash/nameai";
+```
+
+### Basic Name Inspection
+
+Inspect a name:
+
+```ts
+const report = await nameai.inspectName("vitalik.eth");
+
+// Example response:
+{
+  nameai: {
+    // Quality score (0.0 to 1.0) for the first label
+    purity_score: 0.29,
+    
+    // Ranking score (0.0 to 1.0) for the first label
+    sort_score: 0.35,
+    
+    analysis: {  // undefined for uninspected names
+      // The normalization status of the name (normalized, unnormalized, or unknown)
+      status: "normalized",
+      
+      // Details about the inspected name component
+      inspection: {
+        label: "vitalik",
+        // ... other inspection details
+      },
+      
+      // Text meaningfulness (0.0 to 1.0)
+      probability: 0.95,
+      
+      // Natural log of probability (≤ 0.0)
+      log_probability: -0.05,
+      
+      // Minimum words in valid tokenizations
+      word_count: 1,
+      
+      // Recommended word breakdown (may be undefined)
+      top_tokenization: ["vitalik"],
+      
+      // All possible tokenizations (up to 1000)
+      tokenizations: [
+        {
+          tokens: ["vitalik"],
+          probability: 0.95,
+          log_probability: -0.05
+        }
+      ]
+    }
+  },
+  nameguard: NameGuardReport  // Standard NameGuard security inspection
+}
+```
+
+### Tokenization Inspection
+
+The SDK provides detailed tokenization inspection:
+
+```ts
+const { nameai: { analysis } } = await nameai.inspectName("cryptowallet.eth");
+
+console.log(analysis.top_tokenization); // ["crypto", "wallet"]
+console.log(analysis.tokenizations); // Array of possible tokenizations with probabilities
+```
+
+### Custom Client
+
+You can create a custom client with different settings:
+
+```ts
+import { createClient } from "@namehash/nameai";
+
+const nameai = createClient({
+  nameaiEndpoint: "...",
+  network: "sepolia"
+});
+```
+
+## Limitations
+
+- Maximum name length: 200 characters (including dots)
+- Maximum unknown labels: 5
+- Names exceeding these limits will have undefined analysis
+
+## Contact Us
+
+Visit our [website](https://namehashlabs.org/) to get in contact.
+
+## License
+
+Licensed under the MIT License, Copyright © 2023-present [NameHash Labs](https://namehashlabs.org).
+
+See [LICENSE](./LICENSE) for more information.