Added docs folder

2025-06-02 17:07:33 +02:00 · 2025-06-02 17:07:33 +02:00 · 3e15e9f85a
commit 3e15e9f85a
parent 841f5ef294
2 changed files with 2 additions and 2 deletions
--- a/docs/readme.md
+++ b/docs/readme.md
@ -0,0 +1,37 @@
+# fnl
+
+Add or remove final newlines.
+
+## Installation
+
+```shell
+cargo install fnl
+```
+
+## Usage
+
+Show status:
+
+```shell
+find . -type f -name "*.txt" | xargs fnl
+```
+
+Add final newlines:
+
+```shell
+find . -type f -name "*.txt" | xargs fnl --add
+```
+
+Remove final newlines:
+
+```shell
+find . -type f -name "*.txt" | xargs fnl --remove
+```
+
+## License
+
+Please see the [license documentation](https://urbach.dev/license).
+
+## Copyright
+
+© 2025 Eduard Urbach