README.md in trakio-ruby-0.1.4 vs README.md in trakio-ruby-0.2.0
- old
+ new
@@ -29,51 +29,61 @@
```ruby
# create the instance
trakio = Trakio.new 'my_api_token'
# track my-event
resp = trakio.track distinct_id: 'user@example.com', event: 'my-event'
- # resp will look like { 'status': 'success', 'trak_id': '12345' }
+ # resp will look like { 'status': 'success' }
```
### Creating a default instance, and then tracking an event.
```ruby
# set token on default instance
Trakio.init 'my_api_token'
# track our event
- resp = Trakio.track distinct_id: 'user@example.com', event: 'my-event'
- # resp will look like { 'status': 'success', 'trak_id': '12345' }
+ resp = Trakio.track distinct_id: 'user@example.com', company_id: 'acme_ltd', event: 'my-event'
+ # resp will look like { 'status': 'success' }
```
+
### Creating an instance and aliasing an entry
```ruby
# set token on default instance
Trakio.init 'my_api_token'
resp = Trakio.alias distinct_id: 'u1@example.com', alias: ['u2@example.com']
- # resp will look like { 'status': 'success', 'trak_id': '12345', 'distinct_ids': ['u1@example.com', 'u2@example.com'] }
+ # resp will look like { 'status': 'success' }
# an equivilent is shown below
resp = Trakio.alias distinct_id: 'u1@example.com', alias: 'u2@example.com'
- # resp will look like { 'status': 'success', 'trak_id': '12345', 'distinct_ids': ['u1@example.com', 'u2@example.com'] }
+ # resp will look like { 'status': 'success' }
```
### Creating an instance and using identify
```ruby
# set token on default instance
Trakio.init 'my_api_token'
resp = Trakio.identify distinct_id: 'user@example.com', properties: { name: 'Tobie' }
- # resp will look like { 'status': 'success', 'trak_id': '12345', 'distinct_ids': ['user@example.com'] }
+ # resp will look like { 'status': 'success' }
```
+### Creating an instance and using company
+```ruby
+ # set token on default instance
+ Trakio.init 'my_api_token'
+
+ resp = Trakio.company company_id: 'acme_ltd', properties: { name: 'Tobie' }
+ # resp will look like { 'status': 'success' }
+```
+
### Creating an instance and using annotate
```ruby
# set token on default instance
Trakio.init 'my_api_token'
resp = Trakio.annotate event: 'event', channel: 'channel'
- # resp will look like { 'status': 'success', 'trak_id': '12345', 'properties': {} }
+ # resp will look like { 'status': 'success' }
```
## Creating and Running Tests
* Tests can be run by running the following commands `bundle exec rspec`
* Tests can be added by either adding into an existing spec file, or creating a new one.