Commit 7bab34f6 by Jason Zhou

complete readme

parent ac5820d8
# Wildcat
Wildcat is a cli tool for accelerating webpack dev server of Bobcat. It is achieved by the following but not all methods:
- webpack 4
- es2018 code output
- a low cost source map config: `cheap-cheap-module-eval-source-map`
Others like Babel 7 and disabling backend log, even HMR will be considered in future development.
Any ideas of optimization and new features are invited. A merge request would even be better.
## Installation
```
$ npm i -g git+https://cd.i.strikingly.com/jason.zhou/wildcat.git
```
## Usage
1. run
```
wildcat run
```
This command will backup your current config and code files and do the upgrade.
> NOTE: Make sure your current config is the old version. It will not do the judement.
![wildcat run](assets/run-example.png)
1. restore
```
wildcat restore
```
This command will restore the previous config and code files you have backed up. It should be convenient for you to push codes after development. Obviously you don't want to push the altered codes together with yours.
> NOTE: After restore, you still need manually run `npm run update` for `node_modules`.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment