From c78a729a79d99498ca2e218433e2cccbf22fcbc1 Mon Sep 17 00:00:00 2001
From: Tissevert <tissevert+devel@marvid.fr>
Date: Tue, 15 Dec 2020 11:17:27 +0100
Subject: [PATCH] Add example snippets

---
 README.md | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 19e867b..72a1e1c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,34 @@
-# mynixpkgs
+# My Nix Packages
 
-A Nix derivation to easily install the packages I publish.
\ No newline at end of file
+This Nix derivation provides an attribute set with each package referenced by its name to easily install the packages I publish.
+
+## Quick try
+
+To quickly try a package `${PACKAGE_NAME}` from this repository, you can issue on the command line :
+
+```bash
+nix-env -f 'https://git.marvid.fr/Tissevert/mynixpkgs/archive/0.1.0.tar.gz' -i ${PACKAGE_NAME}
+```
+
+## Declarative setup
+
+To use this repository in a more reproducible and less imperative way, you can include the following snippet it in your `/etc/nixos/configuration.nix` or anywhere else you please :
+
+```nix
+let
+  tissevertpkgs = import (
+    fetchTarball https://git.marvid.fr/Tissevert/mynixpkgs/archive/0.1.0.tar.gz
+  ) {};
+in
+```
+
+Then, anywhere where you select packages like for instance in `environment.systemPackages` or in your `users.users.<name>.packages` my packages are available within the attribute set `tissevertpkgs` like this for instance :
+
+```nix
+packages = [ pkgs.git pkgs.vim tissevertpkgs.SJW ]
+```
+
+## Current package selection
+
+- [hablo](/Tissevert/hablo)
+- [SJW](/Tissevert/SJW)