path: root/README.md
diff options
authorTom Ryder <tom@sanctum.geek.nz>2018-11-30 10:10:29 +1300
committerTom Ryder <tom@sanctum.geek.nz>2018-11-30 10:10:29 +1300
commit751172d8646df3b5f1600480ac3e2479ca33be9a (patch)
tree23c51991919686d7015dc1be1a8c2e5588018d7b /README.md
parentMerge branch 'release/v2.0.0' into develop (diff)
Rename README.markdown to README.md
Diffstat (limited to 'README.md')
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..87e8c7c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+Scripts that given a list of repository roots as arguments look for new tags
+available on remote systems, and report the repository name and a tab-indented
+list of new tags, if any.
+Presently only `watch-git-tags` is implemented (well, published). This is all
+implemented in POSIX `sh`, but does require a `mktemp(1)` implementation that
+supports the `-d` option to create temporary directories.
+ $ watch-git-tags ~/.local/src/ed/vim
+ /home/tom/.local/src/ed/vim
+ v8.0.0858
+You can install it in `/usr/local/bin` with:
+ # make install
+You can define a `PREFIX` to install it elsewhere:
+ $ make install PREFIX="$HOME"/.local
+If you keep a list of your repository paths in a file like `~/.watch-git-tags`,
+you could put this in a `crontab(5)` task to email you new tags:
+ xargs watch-git-tags < ~/.watch-git-tags-repos
+Copyright (c) [Tom Ryder][1]. Distributed under an [MIT License][2].
+[1]: https://sanctum.geek.nz/
+[2]: https://www.opensource.org/licenses/MIT