Skip to content

Commit

Permalink
docs(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
simonwong committed Sep 29, 2020
1 parent 590d8cb commit 47c1875
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,32 @@
# fly-helper
工具库

It's a Tool library, method collection.

![test](https://github.com/simonwong/fly-helper/workflows/test/badge.svg)
[![codecov](https://codecov.io/gh/simonwong/fly-helper/branch/master/graph/badge.svg)](https://codecov.io/gh/simonwong/fly-helper)


## Usage

- install

```shell
npm install fly-helper --save

# or

yarn add fly-helper
```

- example

```javascript
import { isNumber } from 'fly-helper'

isNumber()
```


## License

The scripts and documentation in this project are released under the [MIT License](https://github.com/simonwong/fly-helper/blob/master/LICENSE)

0 comments on commit 47c1875

Please sign in to comment.