diff --git a/README.md b/README.md index 08b019b..59558a4 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,12 @@ Go ReportCard

-Write handsome command-line tools with *glamour*! +Write handsome command-line tools with *Glamour*. `glamour` lets you render [markdown](https://en.wikipedia.org/wiki/Markdown) documents & templates on [ANSI](https://en.wikipedia.org/wiki/ANSI_escape_code) -compatible terminals. You can create your own stylesheet or use one of our -glamourous default themes. +compatible terminals. You can create your own stylesheet or simply use one of +the stylish defaults. ## Usage @@ -24,8 +24,8 @@ import "github.com/charmbracelet/glamour" in := `# Hello World -This is a simple example of glamour! -Check out the [other examples](https://github.com/charmbracelet/glamour/tree/master/examples). +This is a simple example of Markdown rendering with Glamour! +Check out the [other examples](https://github.com/charmbracelet/glamour/tree/master/examples) too. Bye! ` @@ -34,7 +34,7 @@ out, err := glamour.Render(in, "dark") fmt.Print(out) ``` -![HelloWorld Example](https://github.com/charmbracelet/glamour/raw/master/examples/helloworld/helloworld.png) +Hello World example ### Custom Renderer @@ -83,5 +83,5 @@ Part of [Charm](https://charm.sh). The Charm logo -Charm热爱开源! / Charm loves open source! +Charm热爱开源 • Charm loves open source diff --git a/examples/helloworld/helloworld.png b/examples/helloworld/helloworld.png index 83aabba..50fe09f 100644 Binary files a/examples/helloworld/helloworld.png and b/examples/helloworld/helloworld.png differ diff --git a/examples/helloworld/main.go b/examples/helloworld/main.go index 535b28c..53282da 100644 --- a/examples/helloworld/main.go +++ b/examples/helloworld/main.go @@ -9,8 +9,8 @@ import ( func main() { in := `# Hello World -This is a simple example of glamour! -Check out the [other examples](https://github.com/charmbracelet/glamour/tree/master/examples). +This is a simple example of Markdown rendering with Glamour! +Check out the [other examples](https://github.com/charmbracelet/glamour/tree/master/examples) too. Bye! `