aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..fb49318
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,27 @@
+`watch-vcs-tags`
+================
+
+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 `git` 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
+
+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 < /home/tom/.watch-git-tags-repos
+
+License
+-------
+
+Copyright (c) [Tom Ryder][1]. Distributed under an [MIT License][2].
+
+[1]: https://sanctum.geek.nz/
+[2]: https://www.opensource.org/licenses/MIT