Contents

# CompactIndexClient

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'compact_index_client'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install compact_index_client

## Usage

Initialize a new `CompactIndexClient` with a root directory for the local copy of the compact index, and a block used to make HTTP requests.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bundler/compact_index_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
compact_index_client-0.1.0	README.md