Skip to content

Commit b314c7b

Browse files
authoredJul 2, 2021
Improve readme.md (#86)
1 parent 20bbfde commit b314c7b

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed
 

‎readme.md

+18-14
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,9 @@ $ npm install figures
1616

1717
## Usage
1818

19-
See the [source](index.js) for supported symbols.
20-
2119
```js
2220
import figures, {replaceSymbols, mainSymbols, windowsSymbols} from 'figures';
2321

24-
console.log(figures.replaceSymbols('✔︎ check'));
25-
// On non-Windows OSes: ✔︎ check
26-
// On Windows: √ check
27-
2822
console.log(figures.tick);
2923
// On non-Windows OSes: ✔︎
3024
// On Windows: √
@@ -34,10 +28,28 @@ console.log(figures.mainSymbols.tick);
3428

3529
console.log(figures.windowsSymbols.tick);
3630
// On all OSes: √
31+
32+
console.log(figures.replaceSymbols('✔︎ check'));
33+
// On non-Windows OSes: ✔︎ check
34+
// On Windows: √ check
3735
```
3836

3937
## API
4038

39+
### figures (default export)
40+
41+
Type: `object`
42+
43+
Symbols to use on any terminal.
44+
45+
### mainSymbols
46+
47+
Symbols to use when not running on Windows.
48+
49+
### windowsSymbols
50+
51+
Symbols to use when running on Windows.
52+
4153
### replaceSymbols(string)
4254

4355
Returns the input with replaced fallback Unicode symbols on Windows.
@@ -50,14 +62,6 @@ Type: `string`
5062

5163
String where the Unicode symbols will be replaced with fallback symbols depending on the OS.
5264

53-
### mainSymbols
54-
55-
Symbols to use when not running on Windows.
56-
57-
### windowsSymbols
58-
59-
Symbols to use when running on Windows.
60-
6165

6266
## Figures
6367

0 commit comments

Comments
 (0)
Please sign in to comment.