aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cfa7c92
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# lua_uuid
+
+Lua library that generate UUIDs leveraging libuuid.
+
+## Usage
+
+To generate an unique UUID string:
+
+```lua
+local lua_uuid = require "lua_uuid"
+local uuid_str = lua_uuid.generate()
+
+print("The UUID is "..uuid_str)
+``` \ No newline at end of file