diff --git a/.gitignore b/.gitignore index 91f7990..f2d2669 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /*.md +/releases diff --git a/README.md b/README.md index bf884dd..ec7526e 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,22 @@ This binary compiles Markdown files into HTML. In particular, code blocks of the following format: -
+# Section Title
+
```go
fmt.Println("hello world")
-```
-
+```
Will be parsed and compiled to HTML using [`chroma`, a tool for generating
syntax highlights][chroma]. The rest of the file will be compiled from markdown
to HTML.
+```html
+fmt.Println("hello world") ++``` + Input can be sent either on standard input or by specifying a filename at the command line. All outputs are printed to standard output, where they can be redirected to a file: @@ -35,3 +41,21 @@ that prevents in-memory Markdown compilation. [error]: https://github.com/russross/blackfriday/issues/403 [chroma]: https://github.com/alecthomas/chroma + +## Installation + +Find your target operating system (darwin, windows, linux) and desired bin +directory, and modify the command below as appropriate: + + curl --silent --location --output=/usr/local/bin/chroma-markdown https://github.com/kevinburke/chroma-markdown/releases/download/0.1/chroma-markdown-linux-amd64 && chmod 755 /usr/local/bin/chroma-markdown + +The latest version is 0.1. + +If you have a Go development environment, you can also install via source code: + +``` +go get -u github.com/kevinburke/chroma-markdown +``` + +This should place a `chroma-markdown` binary in `$GOPATH/bin`, so for me, +`~/bin/chroma-markdown`.