mirror of
https://github.com/charmbracelet/glow.git
synced 2026-08-20 15:14:17 +02:00
README and LICENSE
This commit is contained in:
parent
3b0f6f8207
commit
892e2e0198
3 changed files with 40 additions and 1 deletions
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -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.
|
||||
18
README.md
Normal file
18
README.md
Normal 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).
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
# Charm Gold
|
||||
# Gold
|
||||
|
||||
Render markdown on the CLI, with _pizzazz_!
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue