about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authoryuzu <yuzu@b9215c17-b818-4693-b096-d1e41a411fef>2025-08-01 08:48:17 +0000
committeryuzu <yuzu@b9215c17-b818-4693-b096-d1e41a411fef>2025-08-01 08:48:17 +0000
commit2df86268298de8a4961c3296c19b0767565453e8 (patch)
tree1f048c96efaeb0959e04ad4273a149a108491361 /README.md
parent40a65f981a664a186a52fc2981b99a6d8a1191d4 (diff)
downloadsalaryman-2df86268298de8a4961c3296c19b0767565453e8.tar.gz
salaryman-2df86268298de8a4961c3296c19b0767565453e8.tar.bz2
salaryman-2df86268298de8a4961c3296c19b0767565453e8.zip
unix socket get HEAD canon
git-svn-id: svn+ssh://diminuette.aengel.lesbianunix.dev/salaryman/trunk@17 b9215c17-b818-4693-b096-d1e41a411fef
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6dcfdf2..edd83e1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# Work In Progress
+So easy its like having a salaryman manage your services for you.
+
+### Installation
+
+`cargo install salaryman --features "smd"` will install the daemon component.
+`cargo install salaryman --features "sm-cli"` will install the cli component.
+
+These are build in **synchronous** rust with multithreading from inside of a `std::thread::scope()`
+
+To build against the protocol used on the UNIX socket, use `cargo add salaryman --features "protocol"`.
+
+### A note on repos
+Canonical repo is [svn](https://svn.lesbianunix.dev/viewvc/salaryman/trunk/), the git repos available at [sourcehut](https://git.sr.ht/~spicywolf/salaryman) and [github](https;//github.com/karaiwulf/salaryman) are merely conveniences.
+I will still accept issues and patchsets/PRs on either of the git platforms.