summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorkyren <kerriganw@gmail.com>2017-05-22 03:09:59 -0400
committerkyren <kerriganw@gmail.com>2017-05-22 11:16:34 -0400
commitb15ee9053e90effcce412abdb6f3cbb671b1c03b (patch)
tree2b6e9720e45af50f2c2cee79c3ebda01a328a96e /README.md
parent9bed8f499ff7a7d1055dd8cf858bdef07f91408b (diff)
downloadmlua-b15ee9053e90effcce412abdb6f3cbb671b1c03b.zip
Update to use hlist_macro for hlist macros.
You will type hlist! hlist_pat! and HList! so often that every character counts. Apologize for the API churn in the README.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3ece035..9fca154 100644
--- a/README.md
+++ b/README.md
@@ -65,6 +65,12 @@ in rustc. For example:
See [this reddit discussion](http://www.reddit.com/r/rust/comments/5yujt6/) for
details of the current lifetime problem with callback wrapping.
+## API Stability or lack thereof
+
+This library is very much Work In Progress, so there may be a lot of API churn.
+I will try to follow a pre-1.0 semver (if such a thing exists), but that means
+there will just be a large number of API bumps.
+
## Safety
My *goal* is complete safety, it should not be possible to cause undefined
@@ -85,4 +91,5 @@ The library currently attempts to handle each of these situations, but there
are so many ways to cause unsafety with Lua that it just needs more testing.
## Examples
+
Please look at the examples [here](examples/examples.rs).