From e85854f3840e8b77b0a385200bb17ea0ea6b75ab Mon Sep 17 00:00:00 2001 From: Christoph Burgdorf Date: Sun, 14 Sep 2014 00:33:15 +0200 Subject: [PATCH] feat(Readme): describe basic usage --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 47201f9..9366fc3 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,9 @@ clog ==== A conventional changelog for the rest of us + +Try it! + +1. Run `cargo build` + +2. Run `rm -rf changelog.md && ./target/clog --repository=https://github.com/thoughtram/clog`