diff --git a/README.md b/README.md new file mode 100644 index 0000000..eeca4eb --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# cdungeon ▲̶͈̊ + +![cdungeon demo Gif](./demo.gif) + +> What if `cd` was a terminal based dungeon crawler? + +Run this project: + +``` +cargo run --release +``` + +Add a `cdg` command to your shell that allows you to interactively change directories using `cdungeon`: + +``` +source ./activate +``` diff --git a/demo.gif b/demo.gif new file mode 100644 index 0000000..8f9e4ce Binary files /dev/null and b/demo.gif differ