43:ff61f6ad22cd
Anton Shestakov <av6@dwimlabs.net>, Tue, 25 Oct 2016 12:16:06 +0800
docs: tiny rewording

next change 44:e11df013b0a0
previous change 42:a097c60c9c5a

README.md

Permissions: -rw-r--r--

Other formats: Feeds:
# hglib
A pure-Lua library for interacting with Mercurial's command server. It's useful
for Lua applications that want to get all kinds of repository data fast.
Compared to the usual way of executing multiple `hg command`, this library
skips the overhead of starting up a new process every time.
## License
MIT.
## Usage
```
#!lua
local hglib = require 'hglib'
local client = hglib.Client.open('.')
local code, o, e, d = client:runcommand({'log', '-r0'})
client:close()
print('Output: ' .. o)
if #e > 0 then
print('Error: ' .. e)
end
if #d > 0 then
print('Debug: ' .. d)
end
```
See examples/ and spec/ for more.
## Caveats
lpc is Lua 5.1-only.
## Release Notes
### 0.8 (Not released yet)
Version number chosen based on the current state of the project: "about two
point-releases before 1.0". Things that are still missing (for a 1.0):
- Better docs
- Maybe use something better than lpc
- ??????