Clarify CLI and add initial real README

README.md

@@ -1,12 +1,41 @@
+<div align="center">
+<img src="melamine.png" alt="melamine logo">
+
 # melamine
 
-todo!
+**melamine** is a better file shredder
 
-## install
+for linux<br/>
+
+[Installation](#installation) •
+[Example](#example) •
+[Contributing](#contributing) •
+[License](#license)
+</div>
+
+## Installation
+
+todo
 
 ```bash
 sudo apt install --yes --no-install-recommends build-essential python3-dev libzfslinux-dev && \
 sudo pip3 install Cython && \
-git clone https://github.com/truenas/py-libzfs && \
-cd py-libzfs && ./configure --prefix=/usr && sudo make install
+git clone https://github.com/truenas/py-libzfs && pushd py-libzfs && \
+./configure --prefix=/usr && sudo make install && popd && \
+git clone https://sillyhats.mips.uk/pdf/melamine && pushd melamine && \
+python3 -m pip install .
 ```
+
+## Example
+
+todo
+
+## Contributing
+
+If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub.
+
+This tool was written as part of my coursework for CSC 842 - Security Tool Development at Dakota State University. Consequently, I may choose not to maintain this tool beyond the length of the course, but have selected a license that enables open contributions in any case.
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.

melamine/cli.py

@@ -33,9 +33,13 @@ def run() -> None:
         default=[],
         help="Specify directories to be ignored during the process. This option can be used multiple times.",
     )
-    parser.add_argument("--logfile", "-o", type=validate_logfile, help="Specify a file to log all output.")
-    parser.add_argument("--quiet", "-q", action="store_true", help="Silence all output.")
-    parser.add_argument("--verbose", "-v", action="store_true", help="Provide extra output for debugging.")
+    parser.add_argument(
+        "--logfile", "-o", type=validate_logfile, help="Specify a file to log all output (NOT IMPLEMENTED)."
+    )
+    parser.add_argument("--quiet", "-q", action="store_true", help="Silence all output (NOT IMPLEMENTED).")
+    parser.add_argument(
+        "--verbose", "-v", action="store_true", help="Provide extra output for debugging (NOT IMPLEMENTED)."
+    )
     parser.add_argument(
         "paths",
         nargs="+",