Skip to content

Commit 5c2a46f

Browse files
committed
Updates README to include LuaRocks installation instructions.
1 parent 7a3049a commit 5c2a46f

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ The code (and documentation) is not complete yet, however it is usable and this
1313

1414
The API is relatively stable however there may be some detailed changes.
1515

16+
# Installation
17+
If you clone this repository, you are download all the module source code and can run the examples directly.
18+
However, if you want to use the module inside your own project, the best way is to download it using
19+
LuaRocks at the command line:
20+
21+
```bash
22+
luarocks install xml2lua
23+
```
24+
1625
# How to use
1726
A simplified example which parses an XML directly from a string is presented below:
1827

xml2lua-1.0-0.rockspec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ source = {
77
description = {
88
summary = "An XML Parser written entirely in Lua 5.",
99
detailed = [[
10-
Enables parsing an XML file and converting it to a Lua table,
11-
which can be handled directly by your application.
10+
Enables parsing an XML file and converting it to a Lua table,
11+
which can be handled directly by your application.
1212
]],
1313
homepage = "http://manoelcampos.github.io/xml2lua/",
1414
license = "MIT"

0 commit comments

Comments
 (0)