Skip to content

Commit fced747

Browse files
committed
update docs
1 parent 32a44c1 commit fced747

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.verb.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,10 @@ var punctuation = require('{%= name %}');
99
console.log(punctuation().test('!'));
1010
//=> true
1111
```
12+
13+
Pass `true` to get a regex for matching the additional "supplemental" characters mentioned in the wikipedia article.
14+
15+
```js
16+
console.log(punctuation(true).test(''));
17+
//=> true
18+
```

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,18 @@ console.log(punctuation().test('!'));
2222
//=> true
2323
```
2424

25+
Pass `true` to get a regex for matching the additional "supplemental" characters mentioned in the wikipedia article.
26+
27+
```js
28+
console.log(punctuation(true).test(''));
29+
//=> true
30+
```
31+
2532
## About
2633

2734
### Related projects
2835

29-
* [copyright-regex](https://www.npmjs.com/package/copyright-regex): Regex for matching and parsing copyright statements. | [homepage](https://github.com/regexhq/copyright-regex "Regex for matching and parsing copyright statements.")
36+
* [is-punctuation](https://www.npmjs.com/package/is-punctuation): Returns true if the given string is punctuation characters. | [homepage](https://github.com/jonschlinkert/is-punctuation "Returns true if the given string is punctuation characters.")
3037
* [path-root-regex](https://www.npmjs.com/package/path-root-regex): Regular expression for getting the root of a posix or windows filepath. | [homepage](https://github.com/regexhq/path-root-regex "Regular expression for getting the root of a posix or windows filepath.")
3138
* [whitespace-regex](https://www.npmjs.com/package/whitespace-regex): Regular expression for matching the whitespace in a string. | [homepage](https://github.com/regexps/whitespace-regex "Regular expression for matching the whitespace in a string.")
3239
* [word-regex](https://www.npmjs.com/package/word-regex): Regular expression for matching words in a string. Support for english, CJK and Cyrillic. | [homepage](https://github.com/regexps/word-regex "Regular expression for matching words in a string. Support for english, CJK and Cyrillic.")

0 commit comments

Comments
 (0)