route/vendor/github.com/kohkimakimoto/gluayaml/README.md

59 lines
860 B
Markdown

# gluayaml
Yaml parser for [gopher-lua](https://github.com/yuin/gopher-lua)
## Installation
```
go get github.com/kohkimakimoto/gluayaml
```
## API
### `yaml.parse(string)`
Parses yaml formatted string and returns a table. If this function fails, it returns `nil`, plus a string describing the error.
## Usage
```go
package main
import (
"github.com/yuin/gopher-lua"
"github.com/kohkimakimoto/gluayaml"
)
func main() {
L := lua.NewState()
defer L.Close()
L.PreloadModule("yaml", gluayaml.Loader)
if err := L.DoString(`
local yaml = require("yaml")
local str = [==[
key1: value1
key2:
- value2
- value3
]==]
local tb = yaml.parse(str)
print(tb.key1) -- value1
print(tb.key2[1]) -- value2
print(tb.key2[2]) -- value3
`); err != nil {
panic(err)
}
}
```
## Author
Kohki Makimoto <kohki.makimoto@gmail.com>
## License
MIT license.