Skip to content

Commit c279bbd

Browse files
authored
docs: release 1.0.0 (#33)
1 parent da272d4 commit c279bbd

File tree

3 files changed

+27
-21
lines changed

3 files changed

+27
-21
lines changed

CHANGELOG.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
## ✨ 1.0.0
2+
3+
`2019-07-11`
4+
5+
- [Refactor] Reboth with TypeScript.
6+
- [Break] Remove support of `eslint`.
7+
- [Break] Redesign api of `go`, `koei` and `compile`.
8+
- [Feature] Speed `test` up
9+
10+
---

README.md

+16-20
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,38 @@
33
[![CircleCI](https://img.shields.io/circleci/project/github/orzyyyy/nino-cli/master.svg)](https://circleci.com/gh/orzyyyy/nino-cli)
44
[![codecov](https://codecov.io/gh/orzyyyy/nino-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/orzyyyy/nino-cli)
55

6-
A custom-made cli for daily coding using react, includes
6+
A custom-made cli for daily coding using react.
77

8-
- `jest` for test
9-
- `webpack-dev-server` for development
10-
- `webpack` for production
11-
- `babel` at 7
12-
- you won't need `babel-plugin-import` for `antd` or `antd-mobile` or a `.babelrc`
13-
- you also won't need add options of `jest` or `enzyme`, <a href="#test">just add one line in your test file</a>
8+
## ✨ Features
149

15-
I just need a cli to integration all of them, and my wifi ~~wife~~ is Nino for now, so named this repo.
10+
- `jest` for test.
11+
- `webpack-dev-server` for development.
12+
- `webpack` for production.
13+
- `babel` at 7.
14+
- you won't need `babel-plugin-import` for `antd` or `antd-mobile` or a `.babelrc`.
15+
- you also won't need add complex options of `jest` or `enzyme`, [just take one line in your test file](#How-to-config-test).
1616

17-
# who's Nino?
17+
I just need a cli to integration all of them, and my [wifi ~~wife~~](#Who's-Nino) is Nino for now, so named this repo.
1818

19-
https://twitter.com/5Hanayome_anime/status/1074898723581251584
20-
21-
# usage
19+
## ⌨️ Usage
2220

2321
```bash
2422
npm install --save nino-cli
2523
```
2624

27-
then add scripts in `package.json`, like below,
25+
then add scripts in `package.json`, as below,
2826

2927
```json
3028
"scripts": {
3129
"start": "nino go",
3230
"test": "nino test",
3331
"build": "nino koei",
34-
"dev": "nino koei -w-d"
32+
"dev": "nino koei -w -d"
33+
...
3534
}
3635
```
3736

38-
## how to config test
37+
## How-to-config-test
3938

4039
```diff
4140
import React from 'react';
@@ -45,9 +44,6 @@ import { shallow, mount } from 'enzyme';
4544

4645
check [this](https://github.com/airbnb/enzyme/issues/1437#issuecomment-352148740), because the instance of `enzyme` is not the same, so you must config it yourself
4746

48-
# command
47+
# Who's-Nino
4948

50-
- `go` => to start a server, for development
51-
- `test` => for test, using `react` and `jest`
52-
- `koei` => to release, for production in `/dist`
53-
- `koei -w-d` => to release too, but for development, `-w` is watching and `-d` set environment to development
49+
https://twitter.com/5Hanayome_anime/status/1074898723581251584

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nino-cli",
3-
"version": "0.8.5",
3+
"version": "1.0.0",
44
"description": "A cli for Nino, just some simple config of webpack",
55
"main": "./dist/entry/nino.js",
66
"bin": {

0 commit comments

Comments
 (0)