ceos/glow
1
0
Fork 0
mirror of https://github.com/charmbracelet/glow.git synced 2026-08-09 09:49:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update gold usage in README

Browse source
This commit is contained in:
Christian Muehlhaeuser 2019-11-22 04:51:44 +01:00
commit 08b62ec55e
1 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -4,12 +4,23 @@ Render markdown on the CLI, with _pizzazz_!
## Usage
Supply a JSON stylesheet with the `-s` flag. Use a markdown file as the argument.
Supply a JSON stylesheet with the `-s` flag. Use a markdown source as the argument.
Read from file:
```
./gold -s dark.json README.md
```
Read from stdin:
```
./gold -s dark.json -
```
Fetch README from GitHub:
```
./gold -s dark.json https://github.com/charmbracelet/gold
```
## Colors
Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).