docs: update readme

doums · Feb 19, 2023 · dc7e3f4 · dc7e3f4
1 parent ce9d4c7
commit dc7e3f4
Showing 1 changed file with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -20,11 +20,11 @@ item includes:
 
 ### Usage
 
-Move the `ruzy.so` shared library in your project and import it
-from Lua code.
+Move the `libruzy.so` shared library (latest [release](https://github.com/doums/ruzy/releases/latest))
+in your project and import it from Lua code.
 
 ```lua
-  local fuzzy = require('ruzy').fuzzy
+  local fuzzy = require('libruzy').fuzzy
   local res = fuzzy('lou', { 'pierre', 'et', 'le', 'loup' })
   -- res:
   -- { {
@@ -38,6 +38,18 @@ from Lua code.
 
 Skim V2
 
+### Build
+
+#### prerequisites:
+
+- [rust](https://www.rust-lang.org/tools/install)
+
+To build for production run
+
+```
+cargo build --release
+```
+
 ### Credits
 
 - https://crates.io/crates/fuzzy-matcher