docs: README.md

This commit is contained in:
Muhammad Nauman Raza 2024-03-13 19:57:42 +00:00
parent c40a8ed34c
commit d22eafc4d1
No known key found for this signature in database
GPG key ID: 31BC90D626D2DBBE

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# Vaporise
---
Vaporise (`vpr`) is a simple, featureful and memory-safe alternative to the common `rm`, and is written in pure Rust.
> This project is currently a work in progress, and I therefore make no guarantees on stability. There's a lot to be added, too.
## Roadmap
A list of features (or anything else relevant), currently implenented and *not* implemented.
- [X] Deleting directories
- [X] Deleting files
- [X] User-friendly error handling
- [ ] Trashing files through a CLI argument
- [ ] *Shredding* files as is done by `shred`
- [ ] Prompting before every, or just the first, removal