1 files changed, 34 insertions(+), 4 deletions(-)

M README.md

@@ 1,16 1,44 @@
-# purescript-temporary
+# purescript-node-fs-temporary
 Temporary file and directory support. Purescript implementation for UnliftIO.Temporary, which was strongly inspired by/stolen from the https://github.com/feuerbach/temporary package.
 
 ## Usage without purs-nix
 
-To use this package you will need a patched version of `purescript-node-os` until this [PR}(https://github.com/Thimoteus/purescript-node-os/pull/5) gets merged.
+To use this package you will need a patched version of `purescript-node-os` until this [PR](https://github.com/Thimoteus/purescript-node-os/pull/5) gets merged.
 
 repository: `https://github.com/marijanp/purescript-node-os.git`
+
 rev = `d0d672eb42007b544a3148988cf58e9806e70266`
 
 ## Usage with purs-nix
 
-TODO
+In your `flake.nix`:
+
+```nix
+let
+  inherit (inputs.purescript-node-fs-temporary.packages.x86_64-linux) node-fs-temporary;
+
+  purs-nix = inputs.purs-nix {
+    inherit system;
+    overlays = [
+      node-fs-temporary.overlay
+    ];
+  };
+  
+  my-package = purs-nix.build {
+    name = "my-package";
+    src.path = ./.;
+    info = {
+      version = "0.0.1";
+      dependencies = [
+        node-fs-temporary       # important: refer to the derivation not the string
+      ];
+    };
+  };
+in
+{
+  packages.x86_64-linux.my-package = my-package;
+}
+```
 
 ## Run unit-tests
 


@@ 18,6 46,7 @@ To run the unit-tests:
 ```
 nix run .#checks.x86_64-linux.node-fs-temporary
 ```
+
 ## Develop
 
 ### Enter the development environment


@@ 25,7 54,9 @@ nix run .#checks.x86_64-linux.node-fs-temporary
 ```
 nix develop
 ```
+
 or
+
 ```
 nix develop .#default
 ```


@@ 48,4 79,3 @@ purs-nix compile
 purs-nix test
 ```
 
-