summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAnthony Oleinik <[email protected]>2024-03-14 01:59:47 -0700
committerGitHub <[email protected]>2024-03-14 04:59:47 -0400
commit528943263040c9f383361b1a37a3ee4db66412af (patch)
treeff93492146018fa1df1f2cf5f7f19ce324b055ad /README.md
parentb7813d224e7630de289d587c90e444c76f3330a0 (diff)
Add support for other procfile runners (#5)
* WIP * WIP * WIP * done * done * fix CI * fix CI * refactor: default to overmind in mkProcfileRunner * module: cleanup option docs * refactor: cleanup multi-test suite --------- Co-authored-by: seth <[email protected]>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8d1fc45..fa8cf51 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# procfile-nix
-A library + [flake-parts](https://flake.parts/) module that helps you manage procfiles and background jobs with [overmind](https://github.com/DarthSim/overmind)!
+A library + [flake-parts](https://flake.parts/) module that helps you manage procfiles and background jobs with [overmind](https://github.com/DarthSim/overmind) (or any other Procfile runner)!
## Usage
@@ -46,6 +46,9 @@ First, put this in your `flake.nix`:
procGroup = {
redis = lib.getExe' pkgs.redis "redis-server";
};
+
+ # OPTIONAL: switch the Procfile runner if desired.
+ procRunner = pkgs.honcho;
};
in {
default = pkgs.mkShell {
@@ -89,6 +92,9 @@ Then run `nix develop`, `daemons &`, and you're good to go!
}: {
procfiles.daemons.processes = {
redis = lib.getExe' pkgs.redis "redis-server";
+
+ # OPTIONAL: switch the Procfile runner if desired.
+ procRunner = pkgs.honcho;
};
devShells.default = pkgs.mkShell {