Skip to content
This repository was archived by the owner on Dec 29, 2021. It is now read-only.

Commit 554284c

Browse files
committed
Update README
1 parent 39b9cfc commit 554284c

File tree

1 file changed

+11
-19
lines changed

1 file changed

+11
-19
lines changed

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,26 @@
11
hslua-aeson
22
===========
33

4-
[![travis build status]](https://travis-ci.org/hslua/hslua-aeson)
54
[![MIT License]](./LICENSE)
65

6+
Pushes and retrieves aeson `Value`s to and from the Lua stack.
77

8-
Glue to hslua for aeson values.
8+
- `Null` values are encoded as a special value (stored in the
9+
registry field `HSLUA_AESON_NULL`).
910

10-
This provides a `StackValue` instance for aeson's `Value` type. The following
11-
conventions are used:
11+
- Objects are converted to string-indexed tables.
1212

13-
- `Null` values are encoded as a special value (stored in the registry field
14-
`HSLUA_AESON_NULL`). Using `nil` would cause problems with null-containing
15-
arrays.
13+
- Arrays are converted to sequence tables. Array-length is
14+
included as the value at index 0. This makes it possible to
15+
distinguish between empty arrays and empty objects.
1616

17-
- Objects are converted to tables in a straight-forward way.
18-
19-
- Arrays are converted to Lua tables. Array-length is included as the value at
20-
index 0. This makes it possible to distinguish between empty arrays and empty
21-
objects.
22-
23-
- JSON numbers are converted to Lua numbers (usually doubles), which can cause
24-
a loss of precision.
17+
- JSON numbers are converted to Lua numbers (usually doubles).
2518

2619
License
2720
-------
2821

29-
This project is licensed under the liberal MIT license, the same license under
30-
which hslua and lua itself are published. See the [LICENSE](./LICENSE) file for
31-
details.
22+
This project is licensed under the MIT license, the same license
23+
under which hslua and lua itself are published. See the
24+
[LICENSE](./LICENSE) file for details.
3225

33-
[travis build status]: https://img.shields.io/travis/hslua/hslua-aeson/master.svg?style=flat-square
3426
[MIT License]: https://img.shields.io/github/license/hslua/hslua-aeson.svg?style=flat-square

0 commit comments

Comments
 (0)