Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vunb committed Apr 8, 2020
1 parent 52c8bb1 commit e635828
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Command line interface for Kites Framework

# Usage

### Run the following command to init a new kites application
### Create a new kites application

```bash
# generate a new app
Expand All @@ -25,6 +25,29 @@ npm install
npm start
```

### Startup kites application

```bash
$ kites up app.js
```

### Options

```yaml
$ kites --help
Usage: kites [command] [options]

Options:
-v, --version output the version number
-h, --help output usage information

Commands:
version
init|i [options] [name] Init a new kites project
up [options] [script] Startup kites project
*
```
### Built-in templates:
* [kites-template-mvc](https://github.com/vunb/kites-template-mvc) - Assembling all into complete ship (default)
Expand All @@ -42,4 +65,4 @@ MIT License
Copyright (c) 2018 Nhữ Bảo Vũ
<a rel="license" href="./LICENSE" target="_blank"><img alt="The MIT License" style="border-width:0;" width="120px" src="https://raw.githubusercontent.com/hsdt/styleguide/master/images/ossninja.svg?sanitize=true" /></a>
<a rel="license" href="./LICENSE" target="_blank"><img alt="The MIT License" style="border-width:0;" width="120px" src="https://raw.githubusercontent.com/hsdt/styleguide/master/images/ossninja.svg?sanitize=true" /></a>

0 comments on commit e635828

Please sign in to comment.