From 892e2e0198caac43b9f3ddf7a8d205ee921417a3 Mon Sep 17 00:00:00 2001 From: Toby Padilla Date: Fri, 15 Nov 2019 12:27:41 -0600 Subject: [PATCH] README and LICENSE --- LICENSE | 21 +++++++++++++++++++++ README.md | 18 ++++++++++++++++++ cmd/gold/README.md | 2 +- 3 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..beda40d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Charmbracelet, Inc + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d20ff1 --- /dev/null +++ b/README.md @@ -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). diff --git a/cmd/gold/README.md b/cmd/gold/README.md index 7923f1b..28ad07d 100644 --- a/cmd/gold/README.md +++ b/cmd/gold/README.md @@ -1,4 +1,4 @@ -# Charm Gold +# Gold Render markdown on the CLI, with _pizzazz_!