1 files changed, 18 insertions(+), 0 deletions(-)

M README.md

@@ 15,3 15,21 @@ Other nice features are:
 
 * Fast, incremental scanning
 * Simple filesystem-based root database
+
+## Installation
+
+Both a traditional default.nix and a flake are provided. Install with:
+
+    $ nix-env -f . -i
+
+or:
+
+    nix install
+
+## Usage
+
+To scan `PATH` for references and pin them, run
+
+    orchid pin PATH
+
+Use the `--help` flag to see more options.