diff options
| author | Alexander Pickering <alex@cogarr.net> | 2020-07-13 16:38:42 -0400 |
|---|---|---|
| committer | Alexander Pickering <alex@cogarr.net> | 2020-07-13 16:38:42 -0400 |
| commit | f8177ff97d77e29fa52ed55fb340fc63af90001f (patch) | |
| tree | d04d608aebee689852d0836101658d2d8f76f2e1 /README.md | |
| parent | cb3bd57fb3bac138a5426960e413ddd2176c4616 (diff) | |
| download | lua-nng-f8177ff97d77e29fa52ed55fb340fc63af90001f.tar.gz lua-nng-f8177ff97d77e29fa52ed55fb340fc63af90001f.tar.bz2 lua-nng-f8177ff97d77e29fa52ed55fb340fc63af90001f.zip | |
Add readme
Add a readme with a usage example
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..188af88 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# lua-nng
+
+This is a simple binding of [Nanomessage Next Generation](https://github.com/nanomsg/nng) to lua.
+
+## Installation
+
+The easiest way to download lua-nng is with [luarocks](https://github.com/luarocks/luarocks)
+
+```
+luarocks install --server=http://rocks.cogarr.net lua-nng
+```
+
+## Example
+
+ local s1 = nng.pair1_open()
+ local s2 = nng.pair1_open()
+
+ s1:listen("ipc:///tmp/pair.ipc")
+ s2:dial("ipc://tmp/pair.ipc")
+
+ s2:send("hello")
+ print(s1:recv())
+
+prints "hello"
+
+For more examples, see sepc/start\_spec.lua
+
|