From 3be376400a3206fd220360ee4af78eac37a60aa7 Mon Sep 17 00:00:00 2001
From: HerringtonDarkholme
 <2883231+HerringtonDarkholme@users.noreply.github.com>
Date: Thu, 3 Aug 2023 13:41:46 -0700
Subject: [PATCH] doc: add descriptions and links in npm page

---
 crates/napi/README.md    | 20 +++++++++++++++-----
 crates/napi/package.json |  1 +
 npm/README.md            | 11 ++++++++++-
 npm/package.json         |  9 +++++++++
 4 files changed, 35 insertions(+), 6 deletions(-)

diff --git a/crates/napi/README.md b/crates/napi/README.md
index f86507eb..5c8a9ec1 100644
--- a/crates/napi/README.md
+++ b/crates/napi/README.md
@@ -1,6 +1,17 @@
 # @ast-grep/napi
 
-See https://github.com/ast-grep/ast-grep
+<p align=center>
+  <img src="https://ast-grep.github.io/logo.svg" alt="ast-grep"/>
+</p>
+
+## ast-grep(sg)
+
+ast-grep(sg) is a CLI tool for code structural search, lint, and rewriting.
+
+This npm package is for programmatic usage of ast-grep.
+Please see the [API usage guide](https://ast-grep.github.io/guide/api-usage.html) and [API reference](https://ast-grep.github.io/reference/api.html).
+
+Other resources include [ast-grep's official site](https://ast-grep.github.io/) and [repository](https://github.com/ast-grep/ast-grep).
 
 ## Support matrix
 
@@ -12,13 +23,12 @@ See https://github.com/ast-grep/ast-grep
 | macOS x64        | ✓      | ✓      | ✓      |
 | macOS arm64      | ✓      | ✓      | ✓      |
 | Linux x64 gnu    | ✓      | ✓      | ✓      |
-<!-- | Windows x32      | ✓      | ✓      | ✓      | -->
-<!-- | Windows arm64    | ✓      | ✓      | ✓      | -->
-<!-- | Linux x64 musl   | ✓      | ✓      | ✓      | -->
+| Windows x32      | ✓      | ✓      | ✓      |
+| Windows arm64    | ✓      | ✓      | ✓      |
 <!-- | Linux arm gnu    | ✓      | ✓      | ✓      | -->
+<!-- | Linux x64 musl   | ✓      | ✓      | ✓      | -->
 <!-- | Linux arm64 gnu  | ✓      | ✓      | ✓      | -->
 <!-- | Linux arm64 musl | ✓      | ✓      | ✓      | -->
 <!-- | Android arm64    | ✓      | ✓      | ✓      | -->
 <!-- | Android armv7    | ✓      | ✓      | ✓      | -->
 <!-- | FreeBSD x64      | ✓      | ✓      | ✓      | -->
-
diff --git a/crates/napi/package.json b/crates/napi/package.json
index b4350223..a8d4c749 100644
--- a/crates/napi/package.json
+++ b/crates/napi/package.json
@@ -2,6 +2,7 @@
   "name": "@ast-grep/napi",
   "version": "0.10.0",
   "description": "Search and Rewrite code at large scale using precise AST pattern",
+  "homepage": "https://ast-grep.github.io",
   "main": "index.js",
   "repository": "https://github.com/ast-grep/ast-grep",
   "license": "MIT",
diff --git a/npm/README.md b/npm/README.md
index 9dadc7a1..391748f8 100644
--- a/npm/README.md
+++ b/npm/README.md
@@ -1,3 +1,12 @@
 # @ast-grep/cli
 
-Please see https://github.com/ast-grep/ast-grep
+<p align=center>
+  <img src="https://ast-grep.github.io/logo.svg" alt="ast-grep"/>
+</p>
+
+## ast-grep(sg)
+
+ast-grep(sg) is a CLI tool for code structural search, lint, and rewriting.
+
+Please see [ast-grep's official site](https://ast-grep.github.io/) and [repository](https://github.com/ast-grep/ast-grep)
+for more information.
\ No newline at end of file
diff --git a/npm/package.json b/npm/package.json
index e0268b9e..085d0db9 100644
--- a/npm/package.json
+++ b/npm/package.json
@@ -4,10 +4,19 @@
   "publishConfig": {
     "access": "public"
   },
+  "description": "Search and Rewrite code at large scale using precise AST pattern",
+  "homepage": "https://ast-grep.github.io",
   "repository": "https://github.com/ast-grep/ast-grep",
   "engines": {
     "node": ">= 12.0.0"
   },
+  "keywords": [
+    "ast",
+    "pattern",
+    "codemod",
+    "search",
+    "rewrite"
+  ],
   "files": [
     "sg",
     "ast-grep",