Skip to content

Commit

Permalink
Merge pull request #37 from yeojz/feature/beta-badge-and-description
Browse files Browse the repository at this point in the history
Added release info and moved build script
  • Loading branch information
yeojz committed Mar 4, 2018
2 parents 49c3409 + 63a6a3a commit 751ae7c
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,17 @@ This library is also compatible with [Google Authenticator](https://github.com/g

Install the library via:

```
```bash
$ npm install otplib --save

# To install the Release Candidates:
$ npm install otplib@next --save
```

| Current / Stable | [![npm][npm-badge]][npm-link] |
| ----------------- | ---------------------------------- |
| Release Candidate | [![npm][npm-next-badge]][npm-link] |

## Upgrading

This library follows `semver`. As such, major version bumps usually mean API changes or behavior changes. Please check [upgrade notes](https://github.com/yeojz/otplib/wiki/upgrade-notes) for more information, especially before making any major upgrades.
Expand Down Expand Up @@ -133,7 +140,7 @@ const Authenticator = authenticator.Authenticator;
// const inst = new Authenticator();
```

__Example Usage__
**Example Usage**

```js
import { Authenticator } from 'otplib/authenticator';
Expand Down Expand Up @@ -322,6 +329,7 @@ Check out: [CONTRIBUTING.md][pr-welcome-link]

[npm-badge]: https://img.shields.io/npm/v/otplib.svg?style=flat-square
[npm-link]: https://www.npmjs.com/package/otplib
[npm-next-badge]: https://img.shields.io/npm/v/otplib/next.svg?style=flat-square
[npm-downloads-badge]: https://img.shields.io/npm/dt/otplib.svg?style=flat-square
[circle-badge]: https://img.shields.io/circleci/project/github/yeojz/otplib/master.svg?style=flat-square
[circle-link]: https://circleci.com/gh/yeojz/otplib
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion scripts/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ cp README.md dist/README.md
cp LICENSE dist/LICENSE
cp package.json dist/package.json
cp .npmignore dist/.npmignore
cp .npmrc dist/.npmrc
cp scripts/.npmrc dist/.npmrc

0 comments on commit 751ae7c

Please sign in to comment.