Skip to content

Commit

Permalink
Meta tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Jan 1, 2020
1 parent 6d1245d commit b096ceb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 9 deletions.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"description": "ANSI escape codes for styling strings in the terminal",
"license": "MIT",
"repository": "chalk/ansi-styles",
"funding": "https://github.com/chalk/ansi-styles?sponsor=1",
"author": {
"name": "Sindre Sorhus",
"email": "[email protected]",
Expand Down Expand Up @@ -50,7 +51,7 @@
"@types/color-convert": "^1.9.0",
"ava": "^2.3.0",
"svg-term-cli": "^2.1.1",
"tsd": "^0.10.0",
"tsd": "^0.11.0",
"xo": "^0.25.3"
}
}
8 changes: 0 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@ You probably want the higher-level [chalk](https://github.com/chalk/chalk) modul

<img src="screenshot.svg" width="900">


## Install

```
$ npm install ansi-styles
```


## Usage

```js
Expand All @@ -36,7 +34,6 @@ console.log(style.color.ansi16m.hex('#abcdef') + 'Hello world!' + style.color.cl

Each style has an `open` and `close` property.


## Styles

### Modifiers
Expand Down Expand Up @@ -88,7 +85,6 @@ Each style has an `open` and `close` property.
- `bgCyanBright`
- `bgWhiteBright`


## Advanced usage

By default, you get a map of styles, but the styles are also available as groups. They are non-enumerable so they don't show up unless you access them explicitly. This makes it easier to expose only a subset in a higher-level module.
Expand All @@ -112,7 +108,6 @@ console.log(style.codes.get(36));
//=> 39
```


## [256 / 16 million (TrueColor) support](https://gist.github.com/XVilka/8346728)

`ansi-styles` uses the [`color-convert`](https://github.com/Qix-/color-convert) package to allow for converting between various colors and ANSI escapes, with support for 256 and 16 million colors.
Expand Down Expand Up @@ -141,18 +136,15 @@ style.color.ansi16m.hex('#C0FFEE'); // Hex (RGB) to 16 million color foreground
style.bgColor.ansi16m.hex('#C0FFEE'); // Hex (RGB) to 16 million color background code
```


## Related

- [ansi-escapes](https://github.com/sindresorhus/ansi-escapes) - ANSI escape codes for manipulating the terminal


## Maintainers

- [Sindre Sorhus](https://github.com/sindresorhus)
- [Josh Junon](https://github.com/qix-)


---

<div align="center">
Expand Down

0 comments on commit b096ceb

Please sign in to comment.