Add filedust config file, update README, version bump
This commit is contained in:
20
.filedust.conf.example
Normal file
20
.filedust.conf.example
Normal file
@@ -0,0 +1,20 @@
|
||||
# filedust configuration file
|
||||
# Place at: ~/.filedust.conf
|
||||
#
|
||||
# Use this file to customize cleanup behavior.
|
||||
# Only keys matter (no values). Paths are relative to $HOME.
|
||||
#
|
||||
# Patterns (globs) are allowed.
|
||||
|
||||
[exclude]
|
||||
# Add directories or patterns you want filedust to ignore.
|
||||
# Examples:
|
||||
# Projects/important/*
|
||||
|
||||
[include]
|
||||
# Add directories or patterns you want filedust to remove.
|
||||
# Examples:
|
||||
# node_modules
|
||||
# dist
|
||||
# *.tmp
|
||||
# *~
|
||||
12
README.md
12
README.md
@@ -34,7 +34,11 @@ One interactive prompt at the end of the run (unless -y is used).
|
||||
Shows how much disk space can be freed.
|
||||
|
||||
### Safe by design
|
||||
Never touches dotfiles, configs, project files, or anything important.
|
||||
* It ONLY runs within user's `$HOME`
|
||||
|
||||
* Put user in control by reading `~/.filedust.conf`
|
||||
|
||||
* Never touches dotfiles, configs, project files, or anything important unless you want.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -50,6 +54,12 @@ cd filedust/
|
||||
poetry install
|
||||
```
|
||||
|
||||
### Custom config
|
||||
You can download the example and add your custom rule
|
||||
```
|
||||
wget -O ~/.filedust.conf https://raw.githubusercontent.com/guardutils/filedust/main/.filedust.conf.example
|
||||
```
|
||||
|
||||
### TAB completion
|
||||
Add this to your `.bashrc`
|
||||
```
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "filedust"
|
||||
version = "0.2.0"
|
||||
version = "0.3.0"
|
||||
description = "Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)."
|
||||
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
||||
license = "GPL-3.0-or-later"
|
||||
|
||||
Reference in New Issue
Block a user