Skip to content

Commit

Permalink
fix(readme): 完善readme内容
Browse files Browse the repository at this point in the history
  • Loading branch information
PengKang committed Mar 8, 2021
1 parent 9e44b32 commit 23e035e
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 10 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 1.0.0 (2021-03-08)


### Features

* **readme:** 更新内容 ([9e44b32](https://github.com/ps2qwert/component-dev-flow/commit/9e44b322923f2dfd234c0a436511d538002b76d6))



49 changes: 39 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @Author: PengKang
* @Date: 2020-08-11 16:57:54
* @LastEditors: PengKang
* @LastEditTime: 2021-03-08 14:50:55
* @LastEditTime: 2021-03-08 16:03:10
* @FilePath: \react-library\README.md
-->

Expand Down Expand Up @@ -82,7 +82,7 @@ npm link react-library(package.json中的name)

## 5.版本升级、change log 生成及发布

#### 5.1 版本升级 npm version
### 5.1 版本升级 npm version

```
// npm version 命令概览
Expand All @@ -92,18 +92,41 @@ npm version [<newversion> | major | minor | patch | premajor | preminor | prepat
(run in package dir)
```
以下设置都是package里面的版本号
- prerelease
版本号 1.0.0-> 1.0.1-0,再次执行 1.0.1-0 -> 1.0.1-1
- prepatch 版本号1.0.1-1变为 1.0.2-0
- preminor
- premajor
- patch
- minor
- major
#### prerelease

版本号 1.0.0-> 1.0.1-0,再次执行 1.0.1-0 -> 1.0.1-1
> 当执行npm version prerelease时,如果没有预发布号,则增加minor,同时prerelease 设为0;
如果有prerelease, 则prerelease 增加1。

##### prepatch
版本号1.0.1-1变为 1.0.2-0
> 直接升级小号,增加预发布号为0。
##### preminor
版本号1.0.2-0变为 1.1.0-0
> 直接升级中号,小号置为0,增加预发布号为0。

##### premajor
版本号1.1.0-0变为 2.0.0-0
> 直接升级大号,中号、小号置为0,增加预发布号为0。
##### patch

版本号2.0.0变为 2.0.1;

##### minor

版本号2.0.1变为 2.1.0;

##### major

版本号2.0.1变为 3.0.0;

## 6.Readme模板

推荐一份高start的模板[standard-readme](https://github.com/RichardLitt/standard-readme),或者使用[readme-md-generator](https://github.com/kefranabg/readme-md-generator)组件生成,下面贴一个比较简单的readme模板:

# Title

This is an example file with default selections.
Expand All @@ -127,3 +150,9 @@ PRs accepted.
MIT © Richard McRichface


## 7.组件文档搭建

* [dumi](https://d.umijs.org/)
* [vuePress](https://vuepress.vuejs.org/zh/)


0 comments on commit 23e035e

Please sign in to comment.