Update readme

vivlim · Feb 11, 2024 · 792c2d4 · 792c2d4
1 parent 162060c
commit 792c2d4
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# croissant-nix
+
+[Croissant](https://github.com/giann/croissant) is A Lua REPL and debugger implemented in Lua, re-packaged in a Nix flake using [rock-candy](https://github.com/vivlim/rock-candy)
+
+It's also an example of how to use [rock-candy](https://github.com/vivlim/rock-candy) to access [LuaRocks](https://luarocks.org/) from Nix.
+
+## Usage
+This will start Croissant:
+```
+nix run github:vivlim/croissant-nix
+```