Skip to content

Commit

Permalink
🔥 To fix #25, and to fix #26
Browse files Browse the repository at this point in the history
  • Loading branch information
motss committed Dec 17, 2017
1 parent 693d4b3 commit 31f0a2c
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 1,602 deletions.
4 changes: 2 additions & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
*.md text eol=lf
*.scss text eol=lf
*.sh text eol=lf
*.ts text eol=lf
*.ts text eol=lf
*.tsx text eol=lf
*.txt text eol=lf
*.xml text eol=lf
*.yaml text eol=lf
*.yaml text eol=lf
*.yml text eol=lf
9 changes: 9 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
The MIT License (MIT)

Copyright © 2017 Rong Sen Ng <wes.ngrongsen@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
## Pre-requisite

- [Node.js][node-js-url] >= 8.9.0
- [NPM][npm-url] >= 5.5.1 ([NPM][npm-url] comes [Node.js][node-js-url] so there is no need to install separately.)
- [NPM][npm-url] >= 5.5.1 ([NPM][npm-url] comes with [Node.js][node-js-url] so there is no need to install separately.)

## Setup

Expand Down Expand Up @@ -70,14 +70,14 @@ const { normalize } = require('normalize-diacritics');
### normalize(input)

- input <[string][string-mdn-url]> Input string that contains accents/ diacritics.
- returns: <[Promise][promise-mdn-url]<[string][string-mdn-url]>>
- returns: <[Promise][promise-mdn-url]<[string][string-mdn-url]>> Promise which resolves with normalized input string.

This method accepts an input string that contains any accents/ diacritics and normalizes all of them asynchronously and the normalized string will be output as a result.

### normalizeSync(input)

- input <[string][string-mdn-url]> Input string that contains accents/ diacritics.
- returns: <[string][string-mdn-url]>
- returns: <[string][string-mdn-url]> Promise which resolves with normalized input string.

This methods works the same as `normalize(input)` except that this is a synchronous version of `normalize(input)`.

Expand Down
Loading

0 comments on commit 31f0a2c

Please sign in to comment.