Add Cozy (#235)

[xdg-ninja.git] / README.md

diff --git a/README.md b/README.md
index 68fa299b55fb25ed6d25f34974e22e397bbb1901..d650c1faac70f85e1a8b994b0e07c1210cdc4242 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,6 +15,13 @@ The configurations are from the [arch wiki page on XDG_BASE_DIR](https://wiki.ar
 
 ## Running
 
+### Using nix
+
+If you're using [nix](https://nixos.org) and have flakes turned on, you can just run the following command:
+```sh
+nix run github:b3nj5m1n/xdg-ninja
+```
+
 ### Cloning Manually
 
 Clone the repository somewhere, then run the _./xdg-ninja.sh_ script.
@@ -48,15 +55,23 @@ Files in this directory can have any name, but using the name of the program is
 
 ### Automatically Generating Configuration
 
-You can download the _xdgnj_ executable from the releases page. Alternatively you can build it from scratch using _cabal_, _stack_, or the provided docker image in _build/_. (To be clear, this is just a tool that will help you automatically generate the config files, you still only need your shell to run the tests)
+You can download the _xdgnj_ executable from the releases page. Alternatively, you can use the nix flake or build it from scratch using _cabal_, _stack_, or the provided docker image in _build/_. (To be clear, this is just a tool that will help you automatically generate the config files, you still only need your shell to run the tests)
 
 Available commands:
 ```sh
 xdgnj add # Adds a new configuration
 xdgnj prev programs/FILE.json # Preview the configuration for a program
+xdgnj edit programs/FILE.json # Edit the configuration for a program
 xdgnj run # Mostly the same as running the shell script
 ```
 
+#### Using nix
+
+If you're using [nix](https://nixos.org) and have flakes turned on, you can just run the following command:
+```sh
+nix run github:b3nj5m1n/xdg-ninja#xdgnj-bin ...
+```
+
 #### Building from scratch
 
 You can use `cabal build`, `stack build`, or the provided dockerfile in _build/_.
@@ -108,4 +123,4 @@ Now, we can assemble our final json file:
 
 Saving this as _git.json_ in the _programs/_ directory will result in the script picking it up and checking the file.
 
-If you've created a configuration for a file that isn't in the offical repository yet, make sure to create a pull request so that other people can benefit from it as well.
+If you've created a configuration for a file that isn't in the official repository yet, make sure to create a pull request so that other people can benefit from it as well.