README.md in ruby-jq-0.1.7 vs README.md in ruby-jq-0.1.8
- old
+ new
@@ -5,23 +5,16 @@
see [http://stedolan.github.io/jq/](http://stedolan.github.io/jq/).
[](http://badge.fury.io/rb/ruby-jq)
[](https://travis-ci.org/winebarrel/ruby-jq)
-## Installation
+## Prerequisites
-First, please install libjq from HEAD of [git repository](https://github.com/stedolan/jq).
+jq requires the Oniguruma library to provide regex support. To install Oniguruma
+for your system, please follow the instructions in the [jq FAQ](https://github.com/stedolan/jq/wiki/FAQ#installation).
-```sh
-git clone https://github.com/stedolan/jq.git
-cd jq
-autoreconf -i
-./configure --enable-shared
-make
-sudo make install
-sudo ldconfig
-```
+## Installation
Add this line to your application's Gemfile:
gem 'ruby-jq'
@@ -30,9 +23,16 @@
$ bundle
Or install it yourself as:
$ gem install ruby-jq
+
+### Using system libraries
+
+By default, ruby-jq downloads and compiles its own version of libjq. If you
+would like to use your own version of libjq, you can skip this process by
+passing the `--use-system-libraries` flag to `gem install`, or by setting the
+`RUBYJQ_USE_SYSTEM_LIBRARIES` env var.
## Usage
```ruby
require 'jq'