From 8efabde3a90fd1cae8e99335498adad8dc8862f0 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Tue, 29 Mar 2022 17:34:09 +0300 Subject: docs: add README Sponsored-by: author --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md 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—manage cache directory tags + +`cachedir` is a tiny utility for tagging, finding, and untagging +directories as cache directories, according to the + 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 . + -- cgit v1.2.1