aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..361e167
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+git-todo
+========
+
+Output TODO lines since `master` or a specified ref.
+
+
+## Example
+
+ $ git todo b0aa9334017e433225175d323732472c35f51aed
+ src/lib.rs:38: if l.contains("TODO") {
+ src/main.rs:38: // TODO: error if more than one ref given
+
+
+## Install
+On Mac OS X, Git-Todo can be installed with Homebrew:
+
+ $ brew install teddywing/formulae/git-todo
+
+To compile from source or install on other platforms:
+
+ $ cargo install --git https://github.com/teddywing/git-todo.git
+
+
+## Uninstall
+
+ $ cargo uninstall git-todo
+
+
+## License
+Copyright © 2020 Teddy Wing. Licensed under the GNU GPLv3+ (see the included
+COPYING file).