summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/README.md b/README.md
index ed35a59..bd2211c 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,19 @@
[![Build Status](https://travis-ci.org/lamont-granquist/ffi-yajl.png)](https://travis-ci.org/lamont-granquist/ffi-yajl) [![Code Climate](https://codeclimate.com/github/lamont-granquist/ffi-yajl.png)](https://codeclimate.com/github/lamont-granquist/ffi-yajl)
-TODO:
+## TODO
- switching from curling yajl2 sources to using git submodule
- fix rake compile blowing up on libyajl2
- block ruby 1.8.7 from using c extension (segfault)
- test both ffi and ext on platforms that support both (MRI, rbx)
-BUILD NOTES:
- - building libyajl2 requires 'apt-get install cmake' on ubuntu, but note
- that 'apt-get install libyajl2' will be better
+## BUILD NOTES
+
+- building libyajl2 requires 'apt-get install cmake' on ubuntu, but note
+ that 'apt-get install libyajl2' will be better
+
+## KNOWN BUGS
+
+- C Extension segfaults on ruby 1.8.7, so the ffi mode is forced for RUBY_VERSION < 1.9