summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8698502
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# nufetch
+
+[neofetch](https://github.com/dylanaraps/neofetch) or [pfetch](https://github.com/dylanaraps/pfetch), but in [nu](https://www.nushell.sh/)!
+
+## Usage
+
+Assuming you have `nu` [installed](https://www.nushell.sh/book/installation.html):
+
+```
+git clone https://github.com/getchoo/nufetch
+cd nufetch
+./nufetch.nu
+```
+
+## TODO
+
+- [ ] Support package counts
+- [ ] Maybe support the ASCII art...