README@bf2fe3fc2f73 (annotated)
README
Wed, 27 Jun 2018 19:13:27 +0100
- author
- Matthew Wild <mwild1@gmail.com>
- date
- Wed, 27 Jun 2018 19:13:27 +0100
- changeset 419
- bf2fe3fc2f73
- parent 374
- 3267ae7c9217
- permissions
- -rw-r--r--
Makefile: Use configured squish path
| 374 | 1 | # Verse |
| 2 | ||
| 3 | Verse is an XMPP library for Lua. It allows you to connect to an XMPP server, as | |
| 4 | either a client or a component. It also supports connecting over HTTP (BOSH). | |
| 5 | ||
| 6 | Currently Verse supports Lua 5.1 and LuaJIT, though support for later versions of | |
| 7 | Lua is planned (contributions welcome). | |
| 8 | ||
| 9 | Verse shares some of its underlying code with the Prosody XMPP server. To avoid | |
| 10 | duplication, the shared files are not part of the Verse project, but are available | |
| 11 | in Prosody's source repository, and are bundled with official Verse releases. | |
| 12 | ||
| 13 | ## Features | |
| 14 | ||
| 15 | - Standard XMPP, including SRV and TLS support | |
| 16 | - Roster management | |
| 17 | - Service discovery | |
| 18 | - Stream management (XEP-0198) | |
| 19 | - MUC | |
| 20 | - Ad-hoc commands | |
| 21 | - Jingle (peer-to-peer TCP and file transfer) | |
| 22 | - File transfer proxies | |
| 23 | - Message receipts | |
| 24 | - Pubsub | |
| 25 | - Message archive management | |
| 26 | - PEP | |
| 27 | - Many more... | |
| 28 | ||
| 29 | ## Dependencies | |
| 30 | ||
| 31 | Verse requires: | |
| 32 | ||
| 33 | - LuaSocket | |
| 34 | - LuaExpat | |
| 35 | - LuaSec | |
| 36 | ||
| 37 | All these libraries are available for Windows, OS X, many popular Linux distributions, and | |
| 38 | also via LuaRocks. | |
| 39 | ||
| 40 | ## Building | |
| 41 | ||
| 42 | To generate a self-contained verse.lua: | |
| 43 | ||
| 44 | ./configure | |
| 45 | make | |
| 46 | ||
| 47 | The configure script will take a guess at the best place to install verse.lua. To install: | |
| 48 | ||
| 49 | make install # (may require root, e.g. sudo) | |
| 50 | ||
| 51 | If you fetched Verse from its source repository, some files will automatically be fetched | |
| 52 | from Prosody's repository the first time you run 'make'. Official Verse releases already | |
| 53 | include these files. | |
| 54 | ||
| 55 | ## Documentation | |
| 56 | ||
| 57 | See doc/ for a number of example scripts. | |
| 58 |
