Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Nov 7, 2016
1 parent 55420a4 commit 7cb3ef3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 21 deletions.
20 changes: 4 additions & 16 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,13 @@
"browserify": "^13.0.1",
"esmangle": "^1.0.1",
"nyc": "^8.0.0",
"remark-cli": "^1.0.0",
"remark-comment-config": "^4.0.0",
"remark-github": "^5.0.0",
"remark-lint": "^4.0.0",
"remark-validate-links": "^4.0.0",
"remark-cli": "^2.0.0",
"remark-preset-wooorm": "^1.0.0",
"tape": "^4.0.0",
"xo": "^0.17.0"
},
"scripts": {
"build-md": "remark . --quiet --frail",
"build-md": "remark . --quiet --frail --output",
"build-bundle": "browserify index.js --bare -s isWordCharacter > is-word-character.js",
"build-mangle": "esmangle < is-word-character.js > is-word-character.min.js",
"build": "npm run build-md && npm run build-bundle && npm run build-mangle",
Expand All @@ -55,15 +52,6 @@
"branches": 100
},
"remarkConfig": {
"output": true,
"plugins": [
"comment-config",
"github",
"lint",
"validate-links"
],
"settings": {
"bullet": "*"
}
"presets": "wooorm"
}
}
8 changes: 3 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
# is-word-character [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]

<!--lint disable heading-increment list-item-spacing-->

Check if a character is a word character (`\w`, which equals
`[a-zA-Z0-9_]`).

## Installation

[npm][npm-install]:
[npm][]:

```bash
npm install is-word-character
Expand All @@ -28,7 +26,7 @@ wordCharacter('💩'); // false

## API

### `wordCharacter(character)`
### `wordCharacter(character|code)`

Check whether the given character code (`number`), or the character
code at the first position (`string`), is a word character.
Expand All @@ -55,7 +53,7 @@ code at the first position (`string`), is a word character.

[codecov]: https://codecov.io/github/wooorm/is-word-character

[npm-install]: https://docs.npmjs.com/cli/install
[npm]: https://docs.npmjs.com/cli/install

[license]: LICENSE

Expand Down

0 comments on commit 7cb3ef3

Please sign in to comment.