Merge pull request #205 from Tencent/dev

Release 1.2.1, npm support

Author: loviselu

README.md

@@ -42,12 +42,19 @@ TSW 支持用户维度的抓包
 - 操作系统: Windows/Mac/Linux
 - Node.js: 8.0.0+
 
-## 开始
+## npm
+
+1. 需先安装[Node.js](https://nodejs.org/en/download/)，并且Node.js的版本需不低于8.0.0。
+1. npm i @tswjs/tsw
+1. npx --node-arg=--inspect tsw
+1. 预览 -- 打开浏览器，访问 `http://127.0.0.1/` 即可
+
+## git
 
 1. 需先安装[Node.js](https://nodejs.org/en/download/)，并且Node.js的版本需不低于8.0.0。
 1. 安装 -- `git clone https://github.com/Tencent/TSW.git`
 1. 切换工作目录 -- `cd TSW`
-1. 补全依赖 -- `npm install --no-optional`
+1. 补全依赖 -- `npm install`
 1. 启动 --  `node --inspect index.js`
 1. 预览 -- 打开浏览器，访问 `http://127.0.0.1/` 即可
 

README_en.md

@@ -31,15 +31,22 @@ The full content of the request can be seen through the log.
 - OS: Windows/Mac/Linux
 - Node.js: 8.0.0+
 
-## Getting started
+## npm
+
+- Before installing, [download and install Node.js](https://nodejs.org/en/download/). Node.js 8.0.0 or higher is required.
+- npm i @tswjs/tsw
+- npx --node-arg=--inspect tsw
+- Open `http://127.0.0.1/` in your browser.
+
+## git
 
 - Before installing, [download and install Node.js](https://nodejs.org/en/download/). Node.js 8.0.0 or higher is required.
 
 - Clone the repo: `git clone https://github.com/Tencent/TSW.git`
 
 - Enter the TSW: `cd TSW`
 
-- NPM : `npm install --no-optional`
+- NPM : `npm install`
 
 - Run `node --inspect index.js` to start Node.js server
 

index.js

@@ -1,4 +1,5 @@
-/*!
+#!/usr/bin/env node
+/* !
  * Tencent is pleased to support the open source community by making Tencent Server Web available.
  * Copyright (C) 2018 THL A29 Limited, a Tencent company. All rights reserved.
  * Licensed under the MIT License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
@@ -7,8 +8,8 @@
  */
 'use strict';
 
-if(process.mainModule === module){
+if (process.mainModule === module) {
     require('./bin/proxy/index.js');
-}else{
+} else {
     module.exports = require('./plug.js');
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tswjs/tsw",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "A Node.js infrastructure which is designed for improving the efficiency of locating problems, providing multiple functions for front-end developers",
   "scripts": {
     "lint": "eslint examples bin test --fix",
@@ -10,6 +10,9 @@
     "coverage": "nyc --reporter=lcov  --reporter=text npm test && codecov",
     "optional": "npm i heapdump && npm i v8-profiler"
   },
+  "bin": {
+    "tsw": "./index.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/tencent/TSW.git"
@@ -40,9 +43,6 @@
   "keywords": [
     "TSW"
   ],
-  "files": [
-    "bin"
-  ],
   "license": "MIT",
   "engines": {
     "node": ">= 8.0.0"