Skip to content

Commit 5a7da76

Browse files
committed
update readme
1 parent fed59c8 commit 5a7da76

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

readme.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,31 @@ $ npm install --save unicode-range-json
1717
const unicodeRanges = require('unicode-range-json');
1818

1919
unicodeRanges();
20-
//=> 'unicorns & rainbows'
20+
/*
21+
{
22+
"category": "Control character",
23+
"hexrange": ["0000", "001F"],
24+
"range": [0, 31]
25+
},
26+
{
27+
"category": "Basic Latin",
28+
"hexrange": ["0020", "007F"],
29+
"range": [32, 127]
30+
},
31+
...
32+
*/
2133
```
2234

2335

2436
## API
2537

2638
### unicodeRanges()
2739

28-
Returns a JSON object with information about the Unicode Ranges.
40+
Returns a JSON object with following information about the Unicode Ranges:
41+
42+
- `category` : `(String)` The range category name
43+
- `hexrange` : `(Array)` The hexadecimal number range
44+
- `range` : `(Array)` The decimal number range
2945

3046

3147
## Contribution

0 commit comments

Comments
 (0)