]> git.immae.eu Git - github/fretlink/clever-tools-nix.git/commitdiff
Update README for good measure
authorFrédéric Menou <frederic.menou@fretlink.com>
Tue, 19 Jun 2018 22:48:03 +0000 (00:48 +0200)
committerFrédéric Menou <frederic.menou@fretlink.com>
Tue, 19 Jun 2018 22:48:03 +0000 (00:48 +0200)
README.md

index 1dd270b138cf7b09a626d88808d4c50c4699c71a..3e0c1bbbe9672db4776668bd5ecb08e0e8e357ce 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 # clever-tools-nix
+
 Nix derivation to install clever-tools - see https://github.com/CleverCloud/clever-tools
+
+## What's in it
+
+2 derivations to install
+- nodegit.node 0.20.3 for node v51, from prebuilt archive
+- clever-tools 0.9.3, from prebuilt archive
+
+Main job of those derivations is to use patchelf to make it nix compliant.
+
+## How to use it
+
+```nix
+{ pkgs ? import <nixpkgs> {} }:
+
+let
+  clever-tools = pkgs.fetchFromGitHub
+                   { owner  = "fmenou";
+                     repo   = "clever-tools-nix";
+                     rev    = "7c2a7868b387ffd064dd14c51f7b18224cdc5c88";
+                     sha256 = "0r4bc4k90xpq325djvsyix9a6hiabmd4nba14j0plgdrwgzb36rh";
+                   };
+
+in import clever-tools { inherit pkgs; }
+```