Meta tweaks

sindresorhus · Feb 16, 2020 · 3ae05ee · 3ae05ee
1 parent f1ad9fe
commit 3ae05ee
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 82 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -62,7 +62,7 @@ type FigureSet = typeof figureSet
 
 declare const figures: {
 	/**
-	Replace unicode symbols depending on the OS.
+	Replace Unicode symbols depending on the OS.
 
 	@param string - String where the Unicode symbols will be replaced with fallback symbols depending on the OS.
 	@returns The input with replaced fallback Unicode symbols on Windows.
@@ -72,20 +72,24 @@ declare const figures: {
 	import figures = require('figures');
 
 	console.log(figures('✔︎ check'));
-	// On real OSes:  ✔︎ check
-	// On Windows:    √ check
+	// On non-Windows OSes:  ✔︎ check
+	// On Windows:           √ check
 
 	console.log(figures.tick);
-	// On real OSes:  ✔︎
-	// On Windows:    √
+	// On non-Windows OSes:  ✔︎
+	// On Windows:           √
 	```
 	*/
 	(string: string): string;
 
-	/** Figures to use when not running on Windows. */
+	/**
+	Symbols to use when not running on Windows.
+	*/
 	readonly main: FigureSet;
 
-	/** Figures to use when running on Windows. */
+	/**
+	Symbols to use when running on Windows.
+	*/
 	readonly windows: FigureSet;
 } & FigureSet;
 

diff --git a/index.js b/index.js
@@ -124,7 +124,7 @@ const windows = {
 };
 
 if (platform === 'linux') {
-	// The main one doesn't look that good on Ubuntu
+	// The main one doesn't look that good on Ubuntu.
 	main.questionMarkPrefix = '?';
 }
 

diff --git a/license b/license
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (sindresorhus.com)
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.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:
 

diff --git a/makefile.js b/makefile.js
@@ -9,7 +9,7 @@ const data = Object.entries(darwin).map(([name, figure]) => [name, figure, win32
 const jsonTable = [
 	[
 		'Name',
-		'Real OSes',
+		'Non-Windows',
 		'Windows'
 	],
 	...data

diff --git a/package.json b/package.json
@@ -4,10 +4,11 @@
 	"description": "Unicode symbols with Windows CMD fallbacks",
 	"license": "MIT",
 	"repository": "sindresorhus/figures",
+	"funding": "https://github.com/sponsors/sindresorhus",
 	"author": {
 		"name": "Sindre Sorhus",
 		"email": "sindresorhus@gmail.com",
-		"url": "sindresorhus.com"
+		"url": "https://sindresorhus.com"
 	},
 	"engines": {
 		"node": ">=8"

diff --git a/readme.md b/readme.md
@@ -8,14 +8,12 @@
 
 Windows CMD only supports a [limited character set](http://en.wikipedia.org/wiki/Code_page_437).
 
-
 ## Install
 
 ```
 $ npm install figures
 ```
 
-
 ## Usage
 
 See the [source](index.js) for supported symbols.
@@ -24,12 +22,12 @@ See the [source](index.js) for supported symbols.
 const figures = require('figures');
 
 console.log(figures('✔︎ check'));
-// On real OSes:  ✔︎ check
-// On Windows:    √ check
+// On non-Windows OSes:  ✔︎ check
+// On Windows:           √ check
 
 console.log(figures.tick);
-// On real OSes:  ✔︎
-// On Windows:    √
+// On non-Windows OSes:  ✔︎
+// On Windows:           √
 
 console.log(figures.main.tick);
 // On all OSes:  ✔︎
@@ -38,7 +36,6 @@ console.log(figures.windows.tick);
 // On all OSes:  √
 ```
 
-
 ## API
 
 ### figures(string)
@@ -53,85 +50,82 @@ Type: `string`
 
 String where the Unicode symbols will be replaced with fallback symbols depending on the OS.
 
-
 ### figures.main
 
-Figures to use when not running on Windows.
-
+Symbols to use when not running on Windows.
 
 ### figures.windows
 
-Figures to use when running on Windows.
+Symbols to use when running on Windows.
 
 
 ## Figures
 
-| Name               | Real OSes | Windows |
-| ------------------ | :-------: | :-----: |
-| tick               |     ✔     |    √    |
-| cross              |     ✖     |    ×    |
-| star               |     ★     |    *    |
-| square             |     ▇     |    █    |
-| squareSmall        |     ◻     |   [ ]   |
-| squareSmallFilled  |     ◼     |   [█]   |
-| play               |     ▶     |    ►    |
-| circle             |     ◯     |   ( )   |
-| circleFilled       |     ◉     |   (*)   |
-| circleDotted       |     ◌     |   ( )   |
-| circleDouble       |     ◎     |   ( )   |
-| circleCircle       |     ⓞ     |   (○)   |
-| circleCross        |     ⓧ     |   (×)   |
-| circlePipe         |     Ⓘ     |   (│)   |
-| circleQuestionMark |     ?⃝    |   (?)   |
-| bullet             |     ●     |    *    |
-| dot                |     ․     |    .    |
-| line               |     ─     |    ─    |
-| ellipsis           |     …     |   ...   |
-| pointer            |     ❯     |    >    |
-| pointerSmall       |     ›     |    »    |
-| info               |     ℹ     |    i    |
-| warning            |     ⚠     |    ‼    |
-| hamburger          |     ☰     |    ≡    |
-| smiley             |     ㋡     |    ☺    |
-| mustache           |     ෴     |   ┌─┐   |
-| heart              |     ♥     |    ♥    |
-| nodejs             |     ⬢     |    ♦    |
-| arrowUp            |     ↑     |    ↑    |
-| arrowDown          |     ↓     |    ↓    |
-| arrowLeft          |     ←     |    ←    |
-| arrowRight         |     →     |    →    |
-| radioOn            |     ◉     |   (*)   |
-| radioOff           |     ◯     |   ( )   |
-| checkboxOn         |     ☒     |   [×]   |
-| checkboxOff        |     ☐     |   [ ]   |
-| checkboxCircleOn   |     ⓧ     |   (×)   |
-| checkboxCircleOff  |     Ⓘ     |   ( )   |
-| questionMarkPrefix |     ?⃝    |    ？    |
-| oneHalf            |     ½     |   1/2   |
-| oneThird           |     ⅓     |   1/3   |
-| oneQuarter         |     ¼     |   1/4   |
-| oneFifth           |     ⅕     |   1/5   |
-| oneSixth           |     ⅙     |   1/6   |
-| oneSeventh         |     ⅐     |   1/7   |
-| oneEighth          |     ⅛     |   1/8   |
-| oneNinth           |     ⅑     |   1/9   |
-| oneTenth           |     ⅒     |   1/10  |
-| twoThirds          |     ⅔     |   2/3   |
-| twoFifths          |     ⅖     |   2/5   |
-| threeQuarters      |     ¾     |   3/4   |
-| threeFifths        |     ⅗     |   3/5   |
-| threeEighths       |     ⅜     |   3/8   |
-| fourFifths         |     ⅘     |   4/5   |
-| fiveSixths         |     ⅚     |   5/6   |
-| fiveEighths        |     ⅝     |   5/8   |
-| sevenEighths       |     ⅞     |   7/8   |
+| Name               | Non-Windows | Windows |
+| ------------------ | :---------: | :-----: |
+| tick               |      ✔      |    √    |
+| cross              |      ✖      |    ×    |
+| star               |      ★      |    *    |
+| square             |      ▇      |    █    |
+| squareSmall        |      ◻      |   [ ]   |
+| squareSmallFilled  |      ◼      |   [█]   |
+| play               |      ▶      |    ►    |
+| circle             |      ◯      |   ( )   |
+| circleFilled       |      ◉      |   (*)   |
+| circleDotted       |      ◌      |   ( )   |
+| circleDouble       |      ◎      |   ( )   |
+| circleCircle       |      ⓞ      |   (○)   |
+| circleCross        |      ⓧ      |   (×)   |
+| circlePipe         |      Ⓘ      |   (│)   |
+| circleQuestionMark |      ?⃝     |   (?)   |
+| bullet             |      ●      |    *    |
+| dot                |      ․      |    .    |
+| line               |      ─      |    ─    |
+| ellipsis           |      …      |   ...   |
+| pointer            |      ❯      |    >    |
+| pointerSmall       |      ›      |    »    |
+| info               |      ℹ      |    i    |
+| warning            |      ⚠      |    ‼    |
+| hamburger          |      ☰      |    ≡    |
+| smiley             |      ㋡      |    ☺    |
+| mustache           |      ෴      |   ┌─┐   |
+| heart              |      ♥      |    ♥    |
+| nodejs             |      ⬢      |    ♦    |
+| arrowUp            |      ↑      |    ↑    |
+| arrowDown          |      ↓      |    ↓    |
+| arrowLeft          |      ←      |    ←    |
+| arrowRight         |      →      |    →    |
+| radioOn            |      ◉      |   (*)   |
+| radioOff           |      ◯      |   ( )   |
+| checkboxOn         |      ☒      |   [×]   |
+| checkboxOff        |      ☐      |   [ ]   |
+| checkboxCircleOn   |      ⓧ      |   (×)   |
+| checkboxCircleOff  |      Ⓘ      |   ( )   |
+| questionMarkPrefix |      ?⃝     |    ？    |
+| oneHalf            |      ½      |   1/2   |
+| oneThird           |      ⅓      |   1/3   |
+| oneQuarter         |      ¼      |   1/4   |
+| oneFifth           |      ⅕      |   1/5   |
+| oneSixth           |      ⅙      |   1/6   |
+| oneSeventh         |      ⅐      |   1/7   |
+| oneEighth          |      ⅛      |   1/8   |
+| oneNinth           |      ⅑      |   1/9   |
+| oneTenth           |      ⅒      |   1/10  |
+| twoThirds          |      ⅔      |   2/3   |
+| twoFifths          |      ⅖      |   2/5   |
+| threeQuarters      |      ¾      |   3/4   |
+| threeFifths        |      ⅗      |   3/5   |
+| threeEighths       |      ⅜      |   3/8   |
+| fourFifths         |      ⅘      |   4/5   |
+| fiveSixths         |      ⅚      |   5/6   |
+| fiveEighths        |      ⅝      |   5/8   |
+| sevenEighths       |      ⅞      |   7/8   |
 
 
 ## Related
 
 - [log-symbols](https://github.com/sindresorhus/log-symbols) - Colored symbols for various log levels
 
-
 ---
 
 <div align="center">