aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-10-14 23:44:32 +0000
committerGitHub <[email protected]>2024-10-14 23:44:32 +0000
commitd31fd9deb61e3a37065490f2f7da3368197e541f (patch)
tree13cd444572b1b4cd5d17bd4a043c2faae8103cd9
parentchore(flake): bump version (diff)
downloadyae-d31fd9deb61e3a37065490f2f7da3368197e541f.tar.xz
yae-d31fd9deb61e3a37065490f2f7da3368197e541f.zip
docs(readme): add hook
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8e5c599..b3760d0 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,16 @@
Yae is a powerful yet minimal dependency manager intended for use with Nix,
which functions similar to [niv](https://github.com/nmattia/niv/) and [`npins`](https://github.com/andir/npins/).
+<details closed>
+ <summary>Why should I use Yae instead of niv or <a href="https://github.com/andir/npins/"><code>npins</code></a>?</summary>
+
+ 1. No BS helper Nix expressions are needed by Yae. niv and `npins` spit out unnecessary and mostly complicated Nix expressions by default in the form of a file that you need to keep in sync with their mainline source. This requires additional upgrade commands from the CLI to maintain. A Yae environment is a single file and can be placed anywhere.
+ 2. Yae has a simple and coherent source tree. niv has a total of 10000 LOC, `npins` sits at almost 6000 LOC flat, and Yae stands at just shy of 1500 LOC when looking at all files. Yae's core source code itself sits at just 462 LOC, which is much, **much** smaller than that of niv and `npins`' core source trees. This is all to say that Yae implements everything needed to replace niv and `npins` in far less effective code.
+ 3. Yae is simple by nature in design and usage philosophy.
+
+ niv and `npins` are great, but are far too ~~overkill~~ overengineered for me and many other consumers. I say overengineered because I was able to write out Yae's initial implementation in just about thirty-minutes to an hour, and it was already complete enough for me to replace niv or `npins` in all of my production workflows. If you need some niche feature that niv or `npins` have, use them, but if not, Yae is here for you.
+</details>
+
## Introduction
You can try out Yae without installing anything permanently on your system by running