timezone_detection 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,5 +1,31 @@
-= TimezoneDetection
+== INTRODUCTION
 
-This project rocks and uses MIT-LICENSE.
+This gem used for setting client's timezone based on his/her IP.
 
-More description will be available soon.
+== INSTALLATION
+	
+Write it in your Gemfile
+
+	gem "timezone_detection"
+
+Next, execute following sequences of commands:
+
+	rails generate timezone_detection:install
+	
+	rake db:migrate
+
+This gem uses IpInfoDb web service to determine your timezone. API KEY required for dealing with site API, so you should register your own and set it in initializer file ( for this visit http://ipinfodb.com/ ):
+
+For example: *config/initializers/my_own_timezone_initializer.rb*
+
+	TimezoneDetection.config do |cnf|
+		cnf.api_key = "SOME_API_KEY_PROVIDED_FROM_IP_INFO_DB_SITE"
+	end
+	
+== USAGE
+
+Set before_filter in your ApplicationController or wherever you need.
+
+	before_filter :set_timezone
+
+That's it. You are ready to go!

data/lib/timezone_detection/version.rb

@@ -1,3 +1,3 @@
 module TimezoneDetection
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timezone_detection
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ bindir: bin
 cert_chain: []
 date: 2012-08-09 00:00:00.000000000 Z
 dependencies: []
-description: Gem for detecting users timezone by IP address.
+description: Visit https://github.com/Bor1s/timezone-detection for more information.
 email:
 - boris.bbk@gmail.com
 executables: []