docs: update readme

xinyao27 · May 13, 2024 · 7f54dcf · 7f54dcf
1 parent bdd61a6
commit 7f54dcf
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,27 @@
 # cli-high
 
+✨ Tiny syntax highlighting for your terminal
+
 [![NPM version](https://img.shields.io/npm/v/cli-high?color=a1b858&label=)](https://www.npmjs.com/package/cli-high)
 
+## Preview
+
+![cli-high](./screenshot.png)
+
+## CLI Usage
+
+```bash
+npx cli-high ./path/to/your/js/file
+```
+
+## Programmatic Usage
+
+```ts
+import { highlight } from 'cli-high'
+
+const highlighted = highlight('console.log("Hello, World!")')
+```
+
 ## License
 
 [MIT](./LICENSE) License © 2024 [xinyao27](https://github.com/xinyao27)
diff --git a/package.json b/package.json
@@ -41,9 +41,7 @@
     }
   },
   "sideEffects": false,
-  "bin": {
-    "highlight": "./bin/index.js"
-  },
+  "bin": "./bin/index.js",
   "scripts": {
     "build": "unbuild",
     "stub": "unbuild --stub",

diff --git a/screenshot.png b/screenshot.png