README.md in Breinify-0.1.3 vs README.md in Breinify-0.1.4

@@ -1,13 +1,27 @@
-# Breinify
 
-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/Breinify`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Breinify/brein-api-library-java/master/documentation/img/logo.png" alt="Breinify API Java Library" width="250">
+</p>
 
-## Installation
+<p align="center">
+Breinify's DigitalDNA API puts dynamic behavior-based, people-driven data right at your fingertips.
+</p>
 
+### Step By Step Introduction
+
+#### What is Breinify's DigitialDNA
+
+Breinify's DigitalDNA API puts dynamic behavior-based, people-driven data right at your fingertips. We believe that in many situations, a critical component of a great user experience is personalization. With all the data available on the web it should be easy to provide a unique experience to every visitor, and yet, sometimes you may find yourself wondering why it is so difficult.
+
+Thanks to **Breinify's DigitalDNA** you are now able to adapt your online presence to your visitors needs and **provide a unique experience**. Let's walk step-by-step through a simple example.
+
+### Quick start
+
+#### Step 1: Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'Breinify'
 ```
@@ -18,24 +32,102 @@
 
 Or install it yourself as:
 
     $ gem install Breinify
 
-## Usage
 
-TODO: Write usage instructions here
+#### Step 2: Configure the library
 
-## Development
+In order to use the library you need a valid API-key, which you can get for free at [https://www.breinify.com](https://www.breinify.com). In this example, we assume you have the following api-key:
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+**772A-47D7-93A3-4EA9-9D73-85B9-479B-16C6**
 
-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).
+```ruby
+# configure 
+Breinify.setConfig({'apiKey' => '772A-47D7-93A3-4EA9-9D73-85B9-479B-16C6',
+                    'activityEndpoint' => '/activity',
+                    'lookupEndpoint' => '/lookup',
+                    'secret' => 'lmcoj4k2ttzz66qamhg!=',
+                    'timeout' => 1000,
+                    'category' => 'food'
+                    'url' => 'https://api.breinify.com'})
+                    
 
-## Contributing
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/Breinify.
+The Breinify class is now configured with a valid configuration object.
 
 
-## License
+#### Step 3: Start using the library
 
+##### Placing activity triggers
+
+The engine powering the DigitalDNA API provides two endpoints. The first endpoint is used to inform the engine about the activities performed by visitors of your site. The activities are used to understand the user's current interest and infer the intent. It becomes more and more accurate across different users and verticals as more activities are collected. It should be noted, that any personal information is not stored within the engine, thus each individual's privacy is well protected. The engine understands several different activities performed by a user, e.g., landing, login, search, item selection, or logout.
+
+The engine is informed of an activity by executing *Breinify.activity(...)*. 
+
+```Ruby
+# invoke the activity call 
+Breinify.activity({'user' => {'firstName' => 'Fred',
+                                'email' => '[e-mail]',
+                                'lastName' => 'Firestone',
+                                'sessionId' => 'r3V2kDAvFFL_-RBhuc_-Dg'},
+                     'activity' => {
+                         'description' => 'this is the description',
+                         'type' => 'checkout',
+                         'category' => 'food',
+                         'tags' => {'string' => 'string',
+                                    'int' => 5,
+                                    'double' => 9.1,
+                                    'array' => %w(a b c),
+                                    'null' => nil}
+                     }
+                    })
+
+```
+
+That's it! The call will be invoked. 
+
+The following snippets shows a different approach:
+
+```Ruby
+
+  userData = Hash.new
+  userData['email'] = '[e-mail]'
+  userData['lastName'] = 'Fred'
+  userData['firstName'] = 'Firestone'
+  userData['sessionId'] = 'aa8!scdfsf8988'
+
+  additionalData = Hash.new
+  additionalData['referrer'] = 'https://sampleurl.com/track'
+  additionalData['url'] = 'https://sampleurl.com/'
+
+  userData['additional'] = additionalData
+
+  activityData = Hash.new
+  activityData['description'] = 'this is the description'
+  activityData['type'] = 'checkout'
+
+  requestData = Hash.new
+  requestData['user'] = userData
+  requestData['activity'] = activityData
+  requestData['ipAddress'] = '10.111.222.333'
+
+  Breinify.activity(requestData)
+
+```
+
+That's it! The call will be invoked. 
+
+
+
+### Further information
+
+
+### License
+
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+### Further links
+To understand all the capabilities of Breinify's DigitalDNA API, take a look at:
+
+* [Breinify's Website](https://www.breinify.com).