diff options
| author | moteus <mimir@newmail.ru> | 2012-09-05 16:33:56 +0400 |
|---|---|---|
| committer | moteus <mimir@newmail.ru> | 2012-09-05 16:33:56 +0400 |
| commit | 62b5de980d4a70a44903a15f25e8d0610d6ef129 (patch) | |
| tree | 33d8d328c918d2d0685b2944cb12cba37d3e9b99 | |
| parent | 35e6c27ea6cae79624d769343ba3d6ee93252f8d (diff) | |
Add readme
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa9a887 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +#winreg
+
+##Jas Latrix
+Copyright © 2005, 2006 Jas Latrix <jastejada at yahoo dot com>
+
+All Rights Deserved. Use at your own risk!. Shake well before using.
+
+--------------------------------------------------------------------------------
+
+
+#Introduction
+
+winreg is a Lua binary module to Access Microsoft(R) Windows(R) Registry. The registry is a system-defined database that applications and Microsoft(R) Windows(R) system components use to store and retrieve configuration data.
+Load the module via the require function (make sure Lua can find the module), for example:
+
+```lua
+local winreg = require"winreg"
+
+-- prints all the special folders
+hkey = winreg.openkey[[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion]]
+
+skey = hkey:openkey([[Explorer\Shell Folders]])
+for name in skey:enumvalue() do
+ print("\nname: " .. name
+ .. "\npath: " .. skey:getvalue(name))
+end
+```
+
|