clog-tool · cburgdorf · Jul 2, 2015 · Jun 30, 2015 · Jul 1, 2015 · Jul 1, 2015
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -9,19 +9,27 @@ version = "0.7.0"
 authors = ["Christoph Burgdorf <christoph.burgdorf@bvsn.org>"]
 description = "A conventional changelog for the rest of us"
 
+[[bin]]
+doc = false
+name = "clog"
+
 [dependencies]
 regex = "*"
-time = "*"
-clap = "*"
 semver = "*"
 toml = "*"
+clap = "*"
+time = "*"
 
 [dependencies.regex_macros]
+version = "*"
 optional = true
 
 [features]
 default=[]
 
+# For debugging output
+debug=[]
+
 # for building with nightly and unstable features
 # until regex_macros compiles with nightly again, this should be commented out
 # unstable = ["regex_macros"]

diff --git a/Makefile b/Makefile
@@ -0,0 +1,25 @@
+THIS_MAKEFILE_PATH:=$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
+THIS_DIR:=$(shell cd $(dir $(THIS_MAKEFILE_PATH));pwd)
+
+test:
+	cargo test
+
+build:
+	cargo build
+
+doc:
+	cd "$(THIS_DIR)"
+	cp src/lib.rs code.bak
+	cat README.md | sed -e 's/^/\/\/! /g' > readme.bak
+	sed -i '/\/\/ DOCS/r readme.bak' src/lib.rs
+	sed -e "s/\`rust/\`ignore/g" src/lib.rs
+	sed -e "s/\`toml/\`ignore/g" src/lib.rs
+	sed -e "s/\`sh/\`ignore/g" src/lib.rs
+	rm -rf docs/*
+	(cargo doc --no-deps && make clean) || (make clean && false)
+
+clean:
+	cp -r target/doc/* docs/
+	cd "$(THIS_DIR)"
+	mv code.bak src/lib.rs || true
+	rm *.bak || true
diff --git a/README.md b/README.md
@@ -20,29 +20,45 @@ The way this works, is every time you make a commit, you ensure your commit subj
 
 ### Usage
 
-```
+There are two ways to use `clog`, via the command line or a library in your applicaitons.
+
+#### Command Line
+
+```sh
 USAGE:
-	clog [FLAGS] [OPTIONS]
+    clog [FLAGS] [OPTIONS]
 
 FLAGS:
-        --from-latest-tag    use latest tag as start (instead of --from)
+    -c, --config             The Clog Configuration TOML file to use (Defaults to '.clog.toml')**
+    -F, --from-latest-tag    use latest tag as start (instead of --from)
     -h, --help               Prints help information
-        --major              Increment major version by one (Sets minor and patch to 0)
-        --minor              Increment minor version by one (Sets patch to 0)
-        --patch              Increment patch version by one
-    -v, --version            Prints version information
+    -M, --major              Increment major version by one (Sets minor and patch to 0)
+    -m, --minor              Increment minor version by one (Sets patch to 0)
+    -p, --patch              Increment patch version by one
+    -V, --version            Prints version information
 
 OPTIONS:
-        --from <from>                e.g. 12a8546
+    -f, --from <from>                e.g. 12a8546
+    -g, --git-dir <gitdir>           Local .git directory (defaults to current dir + '.git')*
     -o, --outfile <outfile>          Where to write the changelog (Defaults to 'changelog.md')
-    -r, --repository <repository>    e.g. https://github.com/thoughtram/clog
-        --link-style <style>         The commit link style to use, defaults to github [values: Github, Gitlab, Stash]
-        --subtitle <subtitle>        e.g. crazy-release-title
-        --to <to>                    e.g. 8057684 (Defaults to HEAD when omitted)
+    -r, --repository <repo>          Repo used for link generation (without the .git, e.g. https://github.com/thoughtram/clog)
+    -l, --link-style <style>         The style of repository link to generate (Defaults to github) [values: Github, Gitlab, Stash]
+    -s, --subtitle <subtitle>        e.g. "Crazy Release Title"
+    -t, --to <to>                    e.g. 8057684 (Defaults to HEAD when omitted)
         --setversion <ver>           e.g. 1.0.1
+    -w, --work-tree <workdir>        Local working tree of the git project (defaults to current dir)*
+
+* If your .git directory is a child of your project directory (most common, such as
+/myproject/.git) AND not in the current working directory (i.e you need to use --work-tree or
+--git-dir) you only need to specify either the --work-tree (i.e. /myproject) OR --git-dir (i.e. 
+/myproject/.git), you don't need to use both.
+
+** If using the --config to specify a clog configuration TOML file NOT in the current working
+directory (meaning you need to use --work-tree or --git-dir) AND the TOML file is inside your
+project directory (i.e. /myproject/.clog.toml) you do not need to use --work-tree or --git-dir.
 ```
 
-### Try it!
+##### Try it!
 
 1. Clone the repo `git clone https://github.com/thoughtram/clog && cd clog`
 
@@ -52,6 +68,55 @@ OPTIONS:
 
 3. Run clog `./target/release/clog -r https://github.com/thoughtram/clog --setversion 0.1.0 --subtitle crazy-dog --from 6d8183f`
 
+#### As a Library
+
+See the documentation for information on using `clog` in your applications.
+
+##### Try it!
+
+ 1. Clone the `clog` repo so that you have something to search through (Because `clog` uses 
+    specially formatted commit messages)
+```
+$ git clone https://github.com/thoughtram/clog ~/clog
+```
+
+ 2. Add `clog` as a dependency in your `Cargo.toml` 
+
+```toml
+[dependencies]
+clog = "*"
+```
+
+ 3. Use the following in your `src/main.rs`
+
+```rust
+extern crate clog;
+
+use clog::Clog;
+
+fn main() {
+    // Create the struct
+    let mut clog = Clog::with_dir("~/clog").unwrap_or_else(|e| { 
+        println!("{}",e); 
+        std::process::exit(1); 
+    });
+
+    // Set some options
+    clog.repository("https://github.com/thoughtram/clog")
+        .subtitle("Crazy Dog")
+        .from("6d8183f")
+        .version("0.1.0");
+
+    // Write the changelog to the current working directory
+    //
+    // Alternatively we could have used .write_changelog_to("/somedir/some_file.md")
+    clog.write_changelog();
+}
+```
+
+ 4. Compile and run `$ cargo build --release && ./target/release/bin_name
+ 5. View the output in your favorite markdown viewer! `$ vim changelog.md`
+
 ### Default Options
 
 `clog` can also be configured using a default configuration file so that you don't have to specify all the options each time you want to update your changelog. To do this add a `.clog.toml` file to your repository.

diff --git a/docs/FiraSans-Medium.woff b/docs/FiraSans-Medium.woff
diff --git a/docs/FiraSans-Regular.woff b/docs/FiraSans-Regular.woff
diff --git a/docs/Heuristica-Italic.woff b/docs/Heuristica-Italic.woff
diff --git a/docs/SourceCodePro-Regular.woff b/docs/SourceCodePro-Regular.woff
diff --git a/docs/SourceCodePro-Semibold.woff b/docs/SourceCodePro-Semibold.woff
diff --git a/docs/SourceSerifPro-Bold.woff b/docs/SourceSerifPro-Bold.woff
diff --git a/docs/SourceSerifPro-Regular.woff b/docs/SourceSerifPro-Regular.woff
diff --git a/docs/aho_corasick/autiter/index.html b/docs/aho_corasick/autiter/index.html
diff --git a/docs/aho_corasick/autiter/sidebar-items.js b/docs/aho_corasick/autiter/sidebar-items.js
diff --git a/docs/aho_corasick/autiter/struct.Match.html b/docs/aho_corasick/autiter/struct.Match.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../aho_corasick/struct.Match.html">
+</head>
+<body>
+    <p>Redirecting to <a href="../../aho_corasick/struct.Match.html">../../aho_corasick/struct.Match.html</a>...</p>
+    <script>location.replace("../../aho_corasick/struct.Match.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/docs/aho_corasick/autiter/struct.Matches.html b/docs/aho_corasick/autiter/struct.Matches.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../aho_corasick/struct.Matches.html">
+</head>
+<body>
+    <p>Redirecting to <a href="../../aho_corasick/struct.Matches.html">../../aho_corasick/struct.Matches.html</a>...</p>
+    <script>location.replace("../../aho_corasick/struct.Matches.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/docs/aho_corasick/autiter/struct.MatchesOverlapping.html b/docs/aho_corasick/autiter/struct.MatchesOverlapping.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../aho_corasick/struct.MatchesOverlapping.html">
+</head>
+<body>
+    <p>Redirecting to <a href="../../aho_corasick/struct.MatchesOverlapping.html">../../aho_corasick/struct.MatchesOverlapping.html</a>...</p>
+    <script>location.replace("../../aho_corasick/struct.MatchesOverlapping.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/docs/aho_corasick/autiter/struct.StreamMatches.html b/docs/aho_corasick/autiter/struct.StreamMatches.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../aho_corasick/struct.StreamMatches.html">
+</head>
+<body>
+    <p>Redirecting to <a href="../../aho_corasick/struct.StreamMatches.html">../../aho_corasick/struct.StreamMatches.html</a>...</p>
+    <script>location.replace("../../aho_corasick/struct.StreamMatches.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/docs/aho_corasick/autiter/struct.StreamMatchesOverlapping.html b/docs/aho_corasick/autiter/struct.StreamMatchesOverlapping.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../aho_corasick/struct.StreamMatchesOverlapping.html">
+</head>
+<body>
+    <p>Redirecting to <a href="../../aho_corasick/struct.StreamMatchesOverlapping.html">../../aho_corasick/struct.StreamMatchesOverlapping.html</a>...</p>
+    <script>location.replace("../../aho_corasick/struct.StreamMatchesOverlapping.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/docs/aho_corasick/autiter/trait.Automaton.html b/docs/aho_corasick/autiter/trait.Automaton.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="refresh" content="0;URL=../../aho_corasick/trait.Automaton.html">
+</head>
+<body>
+    <p>Redirecting to <a href="../../aho_corasick/trait.Automaton.html">../../aho_corasick/trait.Automaton.html</a>...</p>
+    <script>location.replace("../../aho_corasick/trait.Automaton.html" + location.search + location.hash);</script>
+</body>
+</html>
diff --git a/docs/aho_corasick/full/index.html b/docs/aho_corasick/full/index.html
diff --git a/docs/aho_corasick/full/sidebar-items.js b/docs/aho_corasick/full/sidebar-items.js
@@ -0,0 +1 @@
+initSidebarItems({"struct":[["FullAcAutomaton","A complete Aho-Corasick automaton."]]});