Skip to content

Commit 08c5ae0

Browse files
authored
Refine NameAI Readme Files (#600)
* Refine NameAI Readme Files * Create curly-brooms-jog.md * fix changeset
1 parent 0098240 commit 08c5ae0

File tree

4 files changed

+25
-4
lines changed

4 files changed

+25
-4
lines changed

.changeset/config.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
"namehashlabs.org",
1515
"@namehash/seo",
1616
"@namehash/internal",
17-
"ensnode.io",
1817
"nameai.dev",
1918
"namekit.io",
2019
"namegraph.dev"

.changeset/curly-brooms-jog.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@namehash/nameai-sdk": patch
3+
---
4+
5+
Refine NameAI Readme Files

apps/api.nameai.dev/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
## API
44
The API extends the NameGuard API and is fully compatible with it.
55

6-
NameAI-specific endpoints are under the [api.nameai.dev](https://api.nameai.dev) path prefix and
7-
NameGuard-specific endpoints are under the [api.nameai.dev/nameguard](https://api.nameai.dev/nameguard) path prefix.
6+
NameAI-specific endpoints are under the `https://api.nameai.dev` path prefix and
7+
NameGuard-specific endpoints are under the `https://api.nameai.dev/nameguard` path prefix.
88

99
API documentation is available at [api.nameai.dev/docs](https://api.nameai.dev/docs) for NameAI and [api.nameai.dev/nameguard/docs](https://api.nameai.dev/nameguard/docs) for NameGuard.
1010

1111
Lambda is publicly accessible under given domain [api.nameai.dev](https://api.nameai.dev)
1212

13+
## SDK
14+
The NameAI SDK provides a convenient way to interact with the NameAI API in your JavaScript/TypeScript applications. You can find the SDK implementation and documentation at [github.com/namehash/namekit/tree/main/packages/nameai-sdk](https://github.com/namehash/namekit/tree/main/packages/nameai-sdk).
15+
1316
# AWS deploy
1417
## Requirements
1518
- Poetry - Python package management
@@ -116,3 +119,13 @@ This script can be run manually with `poetry run python -m nameai.generate_stati
116119
Static data is generated once and stored in `nameai/data/static` directory.
117120

118121
Static data is used to speed up NameAI API calls by storing precomputed results in pickle files.
122+
123+
## Contact Us
124+
125+
Visit our [website](https://namehashlabs.org/) to get in contact.
126+
127+
## License
128+
129+
Licensed under the MIT License, Copyright © 2023-present [NameHash Labs](https://namehashlabs.org).
130+
131+
See [LICENSE](./LICENSE) for more information.

packages/nameai-sdk/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# NameAI SDK
22

3-
![NPM Version](https://img.shields.io/npm/v/@namehash/nameai)
3+
[![NPM Version](https://img.shields.io/npm/v/@namehash/nameai)](https://www.npmjs.com/package/@namehash/nameai)
44

55
[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.
66

77
[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.
88

99
⚠️ **This SDK is BETA. Things will change based on the community feedback.**
1010

11+
## Implementation
12+
13+
This SDK provides a TypeScript interface to the NameAI API. Developers interested in the API internals can find the implementation in the [NameAI backend service](https://github.com/namehash/namekit/tree/main/apps/api.nameai.dev).
14+
1115
## Features
1216

1317
Additional features provided by NameAI on top of NameGuard:

0 commit comments

Comments
 (0)