Skip to content

Latest commit

 

History

History
49 lines (28 loc) · 1.58 KB

README.md

File metadata and controls

49 lines (28 loc) · 1.58 KB

EsModel

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/es_model. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'es_model'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install es_model

Usage

Required Env vars:

  • ES_SITE_PREFIX
  • ES_URL

If you need to use multiple site prefixes (multisite builds) then you will set the default with the env var ES_SITE_PREFIX.

You can change the site prefix by calling the EsModel class method set_site_prefix, i.e.

EsModel.set_site_prefix('some_site_')

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/es_model.

License

The gem is available as open source under the terms of the MIT License.