README.md in ngt-0.1.1 vs README.md in ngt-0.2.0

- old
+ new

@@ -4,22 +4,18 @@ [![Build Status](https://travis-ci.org/ankane/ngt.svg?branch=master)](https://travis-ci.org/ankane/ngt) ## Installation -First, [install NGT](https://github.com/yahoojapan/NGT/blob/master/README.md#Installation). For Homebrew, use: - -```sh -brew install ngt -``` - Add this line to your application’s Gemfile: ```ruby gem 'ngt' ``` +**Note:** NGT is not available for Windows yet + ## Getting Started Prep your data ```ruby @@ -82,10 +78,17 @@ ```ruby index.build_index ``` +Optimize the index + +```ruby +optimizer = Ngt::Optimizer.new(outgoing: 10, incoming: 120) +optimizer.execute(path, new_path) +``` + ## Full Example ```ruby dim = 10 objects = [] @@ -138,5 +141,15 @@ - [Report bugs](https://github.com/ankane/ngt/issues) - Fix bugs and [submit pull requests](https://github.com/ankane/ngt/pulls) - Write, clarify, or fix documentation - Suggest or add new features + +To get started with development: + +```sh +git clone https://github.com/ankane/ngt.git +cd ngt +bundle install +bundle exec rake vendor:all +bundle exec rake test +```