Add a screenshot to the README

1 files changed, 25 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f80f9b4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# LSD
+
+A ls command with a lot of pretty colors.
+
+## Description
+
+This project is a rewrite of the super [colorls](https://github.com/athityakumar/colorls)
+project in rust. For now it only handle the `-l` format (used by default).
+
+## Screenshot
+
+![image](https://raw.githubusercontent.com/Peltoche/lsd/assets/screen_lsd.png)
+
+## TODO
+
+- [x] Handle the `-l` option (used by default for now)
+- [x] Handle the `-a` option
+- [ ] Handle the ls without the `-l` option (indentation included)
+- [ ] Add icons before the files names
+- [ ] Handle the tree (`--tree`) output option
+- [ ] Handle the json (`--json`) output option
+- [ ] Handle Named piped
+- [ ] Handle sockets
+- [ ] Handle block devices
+- [ ] Handle character devices