diff --git a/readme.md b/readme.md index 2998e83..3ff5390 100644 --- a/readme.md +++ b/readme.md @@ -16,15 +16,9 @@ $ npm install figures ## Usage -See the [source](index.js) for supported symbols. - ```js import figures, {replaceSymbols, mainSymbols, windowsSymbols} from 'figures'; -console.log(figures.replaceSymbols('✔︎ check')); -// On non-Windows OSes: ✔︎ check -// On Windows: √ check - console.log(figures.tick); // On non-Windows OSes: ✔︎ // On Windows: √ @@ -34,10 +28,28 @@ console.log(figures.mainSymbols.tick); console.log(figures.windowsSymbols.tick); // On all OSes: √ + +console.log(figures.replaceSymbols('✔︎ check')); +// On non-Windows OSes: ✔︎ check +// On Windows: √ check ``` ## API +### figures (default export) + +Type: `object` + +Symbols to use on any terminal. + +### mainSymbols + +Symbols to use when not running on Windows. + +### windowsSymbols + +Symbols to use when running on Windows. + ### replaceSymbols(string) Returns the input with replaced fallback Unicode symbols on Windows. @@ -50,14 +62,6 @@ Type: `string` String where the Unicode symbols will be replaced with fallback symbols depending on the OS. -### mainSymbols - -Symbols to use when not running on Windows. - -### windowsSymbols - -Symbols to use when running on Windows. - ## Figures