Add readme

JacksonTian · Sep 20, 2023 · 4642cee · 4642cee
1 parent 24d6776
commit 4642cee
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
 # cpu_alert
+
 高 CPU 占用进程告警器
+
+## Installation
+
+```sh
+npm i @jacksontian/cpu_alert -g
+```
+
+## Configuration
+
+```sh
+crontab -e
+```
+
+Add the following crontab expression.
+
+```crontab
+* * * * * cpu_alert
+```
+
+## License
+
+Under the [MIT](./LICENSE) License.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "cpu_alert",
+  "name": "@jacksontian/cpu_alert",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
@@ -13,5 +13,6 @@
   "license": "ISC",
   "dependencies": {
     "node-notifier": "^10.0.1"
-  }
+  },
+  "files": ["bin"]
 }