aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMarco Palladino <marco@mashape.com>2015-11-09 10:41:29 -0800
committerMarco Palladino <marco@mashape.com>2015-11-09 10:41:29 -0800
commitc451d2262211af9331de5997a24d8ec4bacbef1e (patch)
tree671174dcc5898f12e798af456749a7ae259a94c1 /README.md
parentdc4c9f1d2b51a72cbd66ddeff1a2880d6b99d57c (diff)
parent03617b9a8cede011d5dbd7009bf7dab00ba67806 (diff)
downloadlua_uuid-c451d2262211af9331de5997a24d8ec4bacbef1e.tar.gz
lua_uuid-c451d2262211af9331de5997a24d8ec4bacbef1e.tar.bz2
lua_uuid-c451d2262211af9331de5997a24d8ec4bacbef1e.zip
Merge pull request #1 from Mashape/feat/direct-function
feat: made the module return a function
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)
+```