motion-beacon 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcfa6aba9e7e4286737429edf5e49f33562180e8
-  data.tar.gz: afe4b1e169f05676957d9beb087b205f56f62183
+  metadata.gz: d3c450e75109a63d7b2ec929c15ae0fb872d1f6c
+  data.tar.gz: 5cf95b83f4ede9267ab8d41e04021cad83ac5c8c
 SHA512:
-  metadata.gz: ce0a119b10fd74dd2ff6592d15f733c4366ce68c95c7c7f72e5199ff748582ec052352076b987655de6a55f0d3a30fa3ef3527f48929c62385e248f7845ed017
-  data.tar.gz: 9251c20f07d1c9dbd632362fb1ec20ea00aaa9a2fc16878c2b3e488248fb8362de26aeee01cceb596f2d1b960215ac1a6f949ba2c563302d978b6cfe5be72a5b
+  metadata.gz: 47c8c238b1df7fd064b1204ff62433b8dda2a27ef330c74ccc908639e92ee6e9b27b53f12cc5019ffac4e37850de374f0d9f0d5e77fa45984f433da304ad3cc3
+  data.tar.gz: 8676cb93cda4a52164fbbedee3c8472598ef13e1d4bea016208962b94095d6e7fc830a0325fd975b893e86baf26dc475b756e0c024fb4b32a3cbf39be478566f

data/README.md

@@ -1,28 +1,54 @@
 # MotionBeacon
 
+iBeacon detection event system. Detect your beacons with ease!
 
-## Installation
+## About
+
+The goal of this project is to create a simple and powerful event-based detection system for iBeacons. MotionBeacon is build on top of CLLocationManager, CLBeaconRegion and CLBeacon. Events are inspired by sugarcube-events.
 
-Add this line to your application's Gemfile:
+example:
 
-    gem 'motion-beaon'
+```ruby
+beaconManager.onEnterRegion { |region| my_code }
+```
 
-And then execute:
+## Installation
 
-    $ bundle
+  gem install motion-beacon
 
-Or install it yourself as:
+  # in Rakefile
+  require 'motion-beacon'
 
-    $ gem install motion-beacon
+  # in terminal
+  $ bundle install
 
 ## Usage
 
-Inlcude MotionBeacon module in your app_delegate.rb:
 
-	include MotionBeacon
+```ruby
+# create beacon manager
+bm = BeaconManager.new('XXXXX-YYY-ZZZ-AAAA-BBBBBBBBB', 'com.company.iBeacons')
+
+# initialize regions
+bm.createRegion(major: 0, minor: 1)
+
+# activate region detection
+bm.startRangingBeacons(major: 0, minor: 1)
+
+# entering region events
+bm.onEnterRegion { |region| my_code }
+bm.onEnterRegion(major: 1) { |region| my_code }
+
+# leaving region events
+bm.onLeaveRegion { |region| my_code }
+bm.onLeaveRegion(major: 1, minor: 1) { |region| my_code }
 
-Once MotionBeacon module is included, you can start using it:
+# changing regions event
+bm.onChangeRegion { |oldRegion, newRegion| my_code }
 
+# loosing all regions event
+bm.onLostRegions { my_code }
+```
 
 
 ## Contributing

data/lib/motion-beacon/version.rb

@@ -1,5 +1,5 @@
 module Motion
   module Beacon
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/motion-beacon.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/motion-beacon/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["CODIUM"]
   gem.email         = ["vaclav.s@codium.co"]
-  gem.description   = "detect iBeacons with simple events"
+  gem.description   = "detect iBeacons with nice events"
   gem.summary       = "Goal of this gem is to add a simple but powerful event system for iBeacon detection."
   gem.homepage      = "https://bitbucket.org/vencacodium/motion-beacon"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: motion-beacon
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - CODIUM
@@ -24,7 +24,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: detect iBeacons with simple events
+description: detect iBeacons with nice events
 email:
 - vaclav.s@codium.co
 executables: []