summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2022-03-29 17:34:09 +0300
committerLars Wirzenius <liw@liw.fi>2022-03-29 17:34:09 +0300
commit8efabde3a90fd1cae8e99335498adad8dc8862f0 (patch)
tree49683914fb6678a26a12778796fd254d38a84efb
parent9deb872eba752d8b12c336606ce2362b04064a5d (diff)
downloadcachedir-rs-8efabde3a90fd1cae8e99335498adad8dc8862f0.tar.gz
docs: add README
Sponsored-by: author
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7fea13d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# cachedir&mdash;manage cache directory tags
+
+`cachedir` is a tiny utility for tagging, finding, and untagging
+directories as cache directories, according to the
+<http://www.bford.info/cachedir/> specification.
+
+~~~sh
+$ cachedir find $HOME
+$ cachedir tag $HOME/.cache
+$ cachedir find $HOME
+/home/liw/.cache
+$ cachedir untag $HOME/.cache
+$ cachedir find $HOME
+$
+~~~
+
+
+## Legalese
+
+Copyright 2022 Lars Wirzenius
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+