From e16e453ed18fbc56e966acf05cdcfb36ff5bf370 Mon Sep 17 00:00:00 2001 From: eduramme Date: Sat, 15 Feb 2025 16:34:53 -0300 Subject: [PATCH 1/2] refine readme --- README.md | 202 +++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 168 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 2e24abc96..57fcafd87 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@

Easily integrate rich ENS user journeys into your wallet, app, or game. -

+

@@ -60,10 +60,12 @@ The NameKit monorepo contains multiple packages and apps. - + - + @@ -162,6 +164,46 @@ The NameKit monorepo contains multiple packages and apps. + + + + + + + + + + + +
                         Source Code SummaryDeployment        Deployment        
+ + + TypeScript + + + nameai-sdk + A JavaScript/TypeScript SDK for integrating AI‐driven naming functionalities. + + + + NPM Version + + +
+ + + TypeScript + + + namegraph-sdk + A JavaScript/TypeScript SDK for integrating graph‐based name analytics and services. + + + + NPM Version + + +
@@ -170,10 +212,10 @@ The NameKit monorepo contains multiple packages and apps. - + - + @@ -292,26 +334,6 @@ The NameKit monorepo contains multiple packages and apps. - - - - - - -
                         Source Code SummaryDeployment        Deployment        
- - - Python - - - ens-label-inspector - Detailed inspection of labels in ENS names. - - - - PyPI Version - - -
@@ -340,7 +362,7 @@ The NameKit monorepo contains multiple packages and apps. - + @@ -355,18 +377,130 @@ The NameKit monorepo contains multiple packages and apps. + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -475,7 +609,7 @@ The NameKit monorepo contains multiple packages and apps. ### Getting started -Use `git` to clone this respository, and install the dependencies using `pnpm` to run NameKit locally: +Use `git` to clone this repository, and install the dependencies using `pnpm` to run NameKit locally: 1. `git clone https://github.com/namehash/namekit.git` 2. `cd namekit` @@ -486,7 +620,7 @@ It's recommended you run `pnpm dev` in the root of the repository to start all a ## Testing -Tests are automatically ran when a new Pull Request is opened. You can run them locally using `pnpm test`. +Tests are automatically run when a new Pull Request is opened. You can run them locally using `pnpm test`. If you're developing locally, you can watch changes and run tests automatically using `pnpm test:watch`. From c15858a6b4e8979772b6cbdb6b50604f67b84302 Mon Sep 17 00:00:00 2001 From: eduramme Date: Sat, 15 Feb 2025 16:51:31 -0300 Subject: [PATCH 2/2] adding comments back --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 57fcafd87..96123bb2a 100644 --- a/README.md +++ b/README.md @@ -60,12 +60,10 @@ The NameKit monorepo contains multiple packages and apps.
                         Source Code Summary ✨ Try it out! ✨ - ens-node -
+ alpha.ensnode.io + 		Multichain indexer for ENS, powered by Ponder. + + Preview + +
- - coming soon + + Next.js Backend for NameKit. Simplify and enhance your integration with ENS. + ensnode.io + Next.js landing page for ENSNode. + + Preview + +
+ + + TypeScript + + + ens-subgraph-transition-tools + Tooling for transitioning ENS subgraphs. -
+ + + Python + + + api.namegraph.dev + Python API for NameGraph. + + Preview + +
+ + + Python + + + NameGraph Collection Templates + Python templates for NameGraph collections. + - +
+ + + Python + + + api.nameai.dev + Python API for NameAI. + + Preview + +
+ + + Next.js + + + nameai.dev + Next.js landing page for NameAI. + + Preview + +
+ + + Next.js + + + namegraph.dev + Next.js landing page for NameGraph. + + Preview + +
@@ -379,7 +513,7 @@ The NameKit monorepo contains multiple packages and apps. Official website for NameGuard. - Preview                  + Preview
- + - + @@ -212,10 +210,10 @@ The NameKit monorepo contains multiple packages and apps.
                         Source Code SummaryDeployment        Deployment        
- + - + @@ -362,7 +360,7 @@ The NameKit monorepo contains multiple packages and apps.
                         Source Code SummaryDeployment        Deployment        
- + @@ -513,7 +511,7 @@ The NameKit monorepo contains multiple packages and apps.
                         Source Code Summary ✨ Try it out! ✨ Official website for NameGuard. - Preview + Preview