aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThibault Charbonnier <thibaultcha@me.com>2015-11-07 01:53:33 -0800
committerThibault Charbonnier <thibaultcha@me.com>2015-11-07 02:02:03 -0800
commit03617b9a8cede011d5dbd7009bf7dab00ba67806 (patch)
treef2fbc2aab8f30bffdf8e2c3b6012de443e3d0274 /README.md
parentb1696f33dd7ae2b621ad8d04f1547df57731d6d0 (diff)
downloadlua_uuid-03617b9a8cede011d5dbd7009bf7dab00ba67806.tar.gz
lua_uuid-03617b9a8cede011d5dbd7009bf7dab00ba67806.tar.bz2
lua_uuid-03617b9a8cede011d5dbd7009bf7dab00ba67806.zip
feat: made the module return a function
- also add lua lib path to the .so creation to ensure compilation (generally lua header files are not in the standrard compiler's search paths) - remove boilerplate - bare minimum of tests additions
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index cfa7c92..ee80f5d 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
# lua_uuid
-Lua library that generate UUIDs leveraging libuuid.
+Lua library that generate UUIDs leveraging [libuuid](http://linux.die.net/man/3/libuuid).
## Usage
-To generate an unique UUID string:
+To generate a new UUID string:
```lua
-local lua_uuid = require "lua_uuid"
-local uuid_str = lua_uuid.generate()
+local uuid = require "lua_uuid"
+local uuid_str = uuid()
-print("The UUID is "..uuid_str)
-``` \ No newline at end of file
+print("New UUID: "..uuid_str)
+```