A few minor edits to the README (#98)

This commit is contained in:
Christian Rocha
2019-12-16 12:04:55 +01:00
committed by Christian Muehlhaeuser
parent 5b742594cc
commit ece6d6de1b
+13 -11
View File
@@ -4,14 +4,12 @@ Render markdown on the CLI, with _pizzazz_!
## What is it? ## What is it?
Gold is a Golang library that allows you to use JSON based stylesheets to A Go library that lets you use JSON-based stylesheets to render Markdown files
render Markdown files in the terminal. Just like CSS, you can define color and in the terminal. Just like CSS, you can define color and style attributes on
style attributes on Markdown elements. The difference is that you use ANSI Markdown elements. The difference is that you use ANSI color and terminal codes
color and terminal codes instead of CSS properties and hex colors. instead of CSS properties and hex colors.
## Usage Available as a library and on the CLI.
See [cmd/gold](cmd/gold/).
## Example Output ## Example Output
@@ -19,18 +17,22 @@ See [cmd/gold](cmd/gold/).
Check out the [Gold Style Gallery](https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.md)! Check out the [Gold Style Gallery](https://github.com/charmbracelet/gold/blob/master/styles/gallery/README.md)!
## CLI Usage
See [cmd/gold](cmd/gold/).
## Colors ## Colors
Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index). Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).
## Development ## Development
Style definitions located in `styles/` can be embedded into the binary by Style definitions located in `styles/` can be embedded into the binary with
running [statik](https://github.com/rakyll/statik): [statik](https://github.com/rakyll/statik):
```console ```console
statik -f -src styles -include "*.json" statik -f -src styles -include "*.json"
``` ```
You can re-generate screenshots of all available styles by running `gallery.sh`. You can re-generate screenshots of all available styles running `gallery.sh`.
This requires `termshot` and `pngcrush` installed on your system! This requires `termshot`, `convert` and `pngcrush` installed on your system!