update: README.md

README.md

@@ -6,16 +6,39 @@
 
 ## 环境要求
 
-项目使用ES7语法，建议使用node8运行此项目
+项目使用 ES7 语法，建议使用 node8 运行此项目
 
 ## 使用方法
 
+### Installation
+
 ```sh
-npm run build
+npm install format-weekly -g
 ```
 
-生成两个文件，一个用于 email，一个用于 zhihu
+### Execution
 
-## TODO
+```sh
+$ format-weekly
+// 指定文件
+$ format-weekly md/weekly.md
+// 制定输出目录
+$ format-weekly -o build md/weekly.md
+```
+
+### Help
+
+```sh
+$ format-weekly -h
 
-wait
+Usage: format-weekly [options] [file.md]
+
+
+Options:
+
+  -V, --version       output the version number
+  -o, --output [out]  configure the output directory
+  -h, --help          output usage information
+```
+
+生成两个文件，一个用于 email，一个用于 zhihu

package.json

@@ -5,9 +5,8 @@
   "bin": {
     "format-weekly": "./bin/format-weekly.js"
   },
-  "main": "./lib/index.js",
   "scripts": {
-    "start": "node .bin/format-weekly"
+    "start": "node ./bin/format-weekly"
   },
   "repository": {
     "type": "git",
@@ -19,6 +18,12 @@
     "url": "https://github.com/CtripFE/format-weekly/issues"
   },
   "homepage": "https://github.com/CtripFE/format-weekly#readme",
+  "contributors": [
+    {
+      "name": "Curtis",
+      "email": "http://chenbingshu.com/"
+    }
+  ],
   "dependencies": {
     "commander": "^2.11.0",
     "lodash": "^4.17.4",