Minor fixes - added LICENSE and improved README

This commit is contained in:
2025-02-04 15:37:22 +03:30
parent 4a33e04ab4
commit 7e13bce767
5 changed files with 744 additions and 8 deletions
+58 -2
View File
@@ -1,2 +1,58 @@
# TBDel (To Be Deleted) - WIP
## A simple command-line tool for managing a list of files and directories marked for deletion. User can add, remove, list, and execute the deletion of these entries.
# TBDel (To Be Deleted)
### A simple command-line tool for managing a list of files and directories marked for deletion. User can add, remove, list, and execute the deletion of these entries.
## Installation
Soon...
## Usage
```shell
Usage: tbdel <command> [arguments]
Available commands:
add <path to file or folder> Add a file or folder to the list
delete <file or folder ID> Deletes a file or folder
deleteall Deletes all items in the list
list Lists all items in the list
help Shows this help message
```
## Examples
* Add a file:
```shell
tbdel add /path/to/my/file.txt
```
* Add a folder:
```shell
tbdel add /path/to/my/folder
```
* List all entries:
```shell
tbdel list
```
* Delete an entry (using its ID):
```shell
tbdel delete 12345 (Assuming '12345' is the ID of the entry you want to delete)
```
* Delete all entries:
```shell
tbdel deleteall
```
* Get help:
```shell
tbdel help
```
## Contributing
#### All contributions are welcome! Feel free to submit pull requests, bug reports, or feature requests.
## License
This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.