Skip to content

Commit

Permalink
chore: update readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
yeojz committed Mar 27, 2018
1 parent 26767ab commit 5ef9ab2
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
22 changes: 16 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,26 @@

[![PRs Welcome][pr-welcome-badge]][pr-welcome-link]

Thank you for opening (and reading) this document. :)
We are open to, and grateful for, any contributions made.
Thank you for reaching this document. :)
Feel free to contribute code, documentation, ideas for improvements or even example snippets.
All are welcomed.

## Semantic Versioning
## Some notes about this project:

### Semantic Versioning

This repository generally follows semantic versioning. We release patch versions for bug fixes, minor versions for new features, and major versions for any breaking changes.

All releases to npm or any other supported distribution channels will corresponding to a tagged commit.

## Testing
### Commit messages

As the release information is generated from commit messages, it is highly recommended that commit messages
are in the format of [conventional-commits](https://conventionalcommits.org/)

For example: `feat(browser): description`, `fix: description`, `chore(readme): description` etc.

### Testing

To only run linting:

Expand All @@ -25,7 +35,7 @@ To continuously watch and run tests, run the following:

`npm run test:watch`

## Sending a Pull Request
### Sending a Pull Request

If you send a pull request, please do it against the master branch.

Expand All @@ -42,5 +52,5 @@ Before submitting a pull request, please make sure the following is done:

Thank you for contributing!

[pr-welcome-badge]: https://img.shields.io/badge/PRs-Welcome-ff69b4.svg?style=flat-square
[pr-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[pr-welcome-link]: https://github.com/yeojz/otplib/blob/master/CONTRIBUTING.md
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ Alternatively you can
* Use unpkg.com

```html
<script src="https://unpkg.com/otplib@^6.0.0/otplib-browser.js"></script>
<script src="https://unpkg.com/otplib@^8.0.0/otplib-browser.js"></script>
```

For a live example, the [project site][project-web] has been built using `otplib-browser.js`.
Expand Down Expand Up @@ -305,7 +305,7 @@ While this library provides the "otpauth" uri, you'll need a library to generate
An example is shown below:

```js
// npm install node-qrcode
// npm install qrcode
import qrcode from 'qrcode';
import otplib from 'otplib';

Expand Down Expand Up @@ -336,7 +336,7 @@ Check out: [CONTRIBUTING.md][pr-welcome-link]
[circle-link]: https://circleci.com/gh/yeojz/otplib
[coveralls-badge]: https://img.shields.io/coveralls/yeojz/otplib/master.svg?style=flat-square
[coveralls-link]: https://coveralls.io/github/yeojz/otplib
[pr-welcome-badge]: https://img.shields.io/badge/PRs-Welcome-ff69b4.svg?style=flat-square
[pr-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[pr-welcome-link]: https://github.com/yeojz/otplib/blob/master/CONTRIBUTING.md
[mdn-uint8array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
[mdn-crypto]: https://developer.mozilla.org/en-US/docs/Web/API/Window/crypto
Expand Down

0 comments on commit 5ef9ab2

Please sign in to comment.