diff --git a/README.md b/README.md index 15f8974..1fe7376 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,12 @@ Render markdown on the CLI, with _pizzazz_! ## What is it? -Gold is a Golang library that allows you to use JSON based stylesheets to -render Markdown files in the terminal. Just like CSS, you can define color and -style attributes on Markdown elements. The difference is that you use ANSI -color and terminal codes instead of CSS properties and hex colors. +A Go library that lets you use JSON-based stylesheets to render Markdown files +in the terminal. Just like CSS, you can define color and style attributes on +Markdown elements. The difference is that you use ANSI color and terminal codes +instead of CSS properties and hex colors. -## Usage - -See [cmd/gold](cmd/gold/). +Available as a library and on the CLI. ## 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)! +## CLI Usage + +See [cmd/gold](cmd/gold/). + ## Colors Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index). ## Development -Style definitions located in `styles/` can be embedded into the binary by -running [statik](https://github.com/rakyll/statik): +Style definitions located in `styles/` can be embedded into the binary with +[statik](https://github.com/rakyll/statik): ```console statik -f -src styles -include "*.json" ``` -You can re-generate screenshots of all available styles by running `gallery.sh`. -This requires `termshot` and `pngcrush` installed on your system! +You can re-generate screenshots of all available styles running `gallery.sh`. +This requires `termshot`, `convert` and `pngcrush` installed on your system!