aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-10-14 03:16:07 -0700
committerFuwn <[email protected]>2024-10-14 03:16:23 -0700
commit552b68c69ed11abc866a8671b6c4d958dbf03069 (patch)
treeb6e036542df6a3eeafcc6b66503461ee57253105 /README.md
parent6ea05d2e7bb6c1bea83e5c71dda375289a66d9a6 (diff)
downloadyae-552b68c69ed11abc866a8671b6c4d958dbf03069.tar.xz
yae-552b68c69ed11abc866a8671b6c4d958dbf03069.zip
docs(readme): expand introductory sections
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index 09092ac..43c716a 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,17 @@
# ⛩️ Yae
-Yae is a simple dependency manager for use with Nix, similar to [niv](https://github.com/nmattia/niv/)
-and [`npins`](https://github.com/andir/npins/).
-
-I made it to solve my own problems, but I hope it can help you too.
+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/).
## Introduction
-You can try out Yae without installing anything permanently by running
+You can try out Yae without installing anything permanently on your system by running
`nix run github:Fuwn/yae`.
-Additionally, [Tsutsumi](https://github.com/Fuwn/tsutsumi) uses Yae to manage
-dependencies. You can check out a working implementation there.
+Check out [Tsutsumi](https://github.com/Fuwn/tsutsumi) to see an example of Yae running
+in a production environment. Tsutsumi fully leverages the power of Yae to manage
+and automagically update the sources of the Nix packages it provides using a simple
+GitHub Actions CRON workflow.
## Usage
@@ -40,7 +40,8 @@ yae add \
zen-browser-bin \
'https://github.com/zen-browser/desktop/releases/download/{version}/zen.linux-specific.tar.bz2'
-# Adds a Yae dependency named `yaak` pinned at tag `2024.10.1` with tag trimming for updates
+# Adds a Yae dependency named `yaak` pinned at tag `2024.10.1` with tag trimming
+# for updates
yae add \
--type git \
--unpack=false \