diff --git a/README.md b/README.md new file mode 100644 index 0000000..5567199 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# text-pic + +This tool generates a social media-friendly graphic from some text. It's especially made to be paired with [WriteFreely](https://writefreely.org), a minimalist blogging platform. + +## Usage + +To run this, you'll need Go installed. With that, you can compile the project: + +``` +go get github.com/writeas/text-pic/cmd/wfgraphic-cli +``` + +Then you can run `wfgraphic-cli` with the options below. The actual content of the graphic is read from `stdin`, which you can either supply when prompted to, or pipe in (e.g. `cat quote.txt | ./wfgraphic-cli`). + +``` +Usage of wfgraphic-cli: + -font string + Post font (options: "serif", "sans", "mono") (default "serif") + -i string + WriteFreely instance hostname (e.g. pencil.writefree.ly) (default "write.as") + -o string + Image output filename (default "out.png") + -u string + WriteFreely author username (for multi-user instances) +``` + +## Examples + +![Sample using default fonts.](https://i.snap.as/NHrWle49.png) + +![Sample using "sans" font and a custom domain.](https://i.snap.as/8SI7lfyb.png) \ No newline at end of file