Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nmsn committed Mar 1, 2023
1 parent 110c277 commit 64f4d1b
Showing 1 changed file with 22 additions and 12 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,33 @@
![npm](https://img.shields.io/npm/v/release-toolbox)
![node version](https://img.shields.io/node/v/release-toolbox)
![license](https://img.shields.io/npm/l/release-toolbox)
![size](https://img.shields.io/bundlephobia/min/release-toolbox)
![last commit](https://img.shields.io/github/last-commit/nmsn/release-toolbox)
![commit activity](https://img.shields.io/github/commit-activity/y/nmsn/release-toolbox)

A script to push code to npm/github and add tags.
English | [简体中文](./README.zh-CN.md)

## Feature
A command line gui `npm/github` release and push script.

## Features

- Light weight.
- `gui` interface operation.
- Version selection in accordance with the `semver` specification.
- Support for `npm/github` tag, support for adding `github release` information.

- gui
- github branch and tag
- npm

## TODO

- [ ] catch err
- [ ] loading animation
- [ ] release template
- [ ] check config in advance
- [ ] Improve error capture.
- [ ] Add process loading animation.
- [ ] Add `release` template.
- [ ] Optimize package size.

## Contributing

- [nmsn](https://github.com/nmsn)

## Finish
## License

- [x] code quality: eslint/prettier/typescript
- [x] github release
[MIT License](https://github.com/nmsn/release-toolbox/blob/main/LICENSE)

0 comments on commit 64f4d1b

Please sign in to comment.