README and LICENSE

This commit is contained in:
Toby Padilla
2019-11-15 12:27:41 -06:00
parent 835820cc49
commit c52e92c122
2 changed files with 39 additions and 0 deletions
+18
View File
@@ -0,0 +1,18 @@
# Gold
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.
## Usage
See [cmd/gold](cmd/gold).
## Colors
Currently `gold` uses the [Aurora ANSI colors](https://godoc.org/github.com/logrusorgru/aurora#Index).