summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3055635
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# dired-rmshit
+
+dired-rmshit is a port of Jakub Klinkovský's rmshit.py to Dired. The interactive
+function, `dired-rmshit` will mark all files in the current Dired buffer that
+match one of the patterns specified in `dired-rmshit-shitty-files`. The tool is
+intended as a simple means for keeping one's home directory tidy -- removing
+"junk" dotfiles.
+
+The original implementation of rmshit.py can be found at:
+<https://github.com/lahwaacz/Scripts/blob/master/rmshit.py>