Merge pull request #2 from rubygarage/feature/info

Gem information

Author: sleekybadger

README.md

@@ -1,41 +1,25 @@
 # Detectify
 
-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/detectify`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Detectify provides a simple way to retrieve an ActiveRecord entity based on the domain/subdomain request information.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'detectify'
-```
-
-And then execute:
+`gem 'detectify', github: 'rubygarage/detectify'`
 
-    $ bundle
+and then execute: `$ bundle`
 
-Or install it yourself as:
-
-    $ gem install detectify
+Finally, restart the server to apply the changes.
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## 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).
+Start off by generating an initializer: `$ bundle exec rails g detectify:install`, this will create file `config/initializers/detectify.rb` in your application directory. You can configure Detectify for your application needs via initializer. After this you can access detected entity via `env['Detectify-Entity']`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/detectify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubygarage/detectify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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).
-

detectify.gemspec

@@ -7,11 +7,12 @@ Gem::Specification.new do |spec|
   spec.name          = 'detectify'
   spec.version       = Detectify::VERSION
   spec.authors       = ['Lukyanov Fedor']
-  spec.email         = ['lukyanov.f.ua@gmail.com']
+  spec.email         = ['fedor@rubygarage.org']
 
-  spec.summary       = 'Write a short summary, because Rubygems requires one.'
-  spec.description   = 'Write a longer description or delete this line.'
-  spec.homepage      = 'https://rubygarage.org'
+  spec.summary       = 'Detect ActiveRecord entity via domain or subdomain'
+  spec.description   = 'Detectify provides a simple way to retrieve an ActiveRecord entity' \
+                       'based on the domain/subdomain request information.'
+  spec.homepage      = 'https://github.com/rubygarage/detectify'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }