README.md in datasift-3.1.5 vs README.md in datasift-3.2.0
- old
+ new
@@ -1,8 +1,7 @@
DataSift
========
-
[][gem]
[][travis]
[gem]: https://rubygems.org/gems/datasift
[travis]: https://travis-ci.org/datasift/datasift-ruby
@@ -10,48 +9,44 @@
The official Ruby library for accessing the DataSift API.
Getting Started
---------------
-
**Read our [Ruby Getting Started Guide](http://dev.datasift.com/quickstart/ruby) to get started with the DataSift platform.** The guide will take you through creating a [DataSift](http://datasift.com) account, and activating data sources which you will need to do before using the DataSift API.
Many of the examples and API endpoints used in this library require you have enabled certain data sources before you can receive any data (you should do this at [datasift.com/source](https://datasift.com/source)). Certain API features, such as [Historics](http://datasift.com/platform/historics/) and [Managed Sources](http://datasift.com/platform/datasources/) will require you have signed up to a monthly subscription before you can access them.
If you are interested in using these features, or would like more information about DataSift, please [get in touch](http://datasift.com/contact-us/)!
Install Instructions
--------------------
-
```
sudo gem install datasift
```
Dependencies
------------
-
If you're using the source you'll need to install the dependencies.
```
sudo gem install rest-client multi_json websocket-td
```
The library will use SSL connections by default. While we recommend using SSL
-you may disable it if required by passing ':enable_ssl => false' as the third
-parameter when creating your @config object.
+you may disable it if required by passing ```enable_ssl: false``` as the third
+parameter when creating your ```@config``` object.
Simple example
--------------
-
This example looks for anything that contains the word "football" in real-time,
and simply prints the content to the screen as they come in.
```ruby
require 'datasift'
-@config = {:username => 'DATASIFT_USERNAME', :api_key => 'DATASIFT_API_KEY', :enable_ssl => true}
+@config = { username: 'DATASIFT_USERNAME', api_key: 'DATASIFT_API_KEY' }
@datasift = DataSift::Client.new(@config)
csdl = 'interaction.content contains "football"'
filter = @datasift.compile csdl
receivedCount = 0
@@ -81,31 +76,37 @@
conn = DataSift::new_stream(@config, on_delete, on_error, on_connect)
conn.on_datasift_message = on_datasift_message
conn.stream.read_thread.join
```
-See the [Understanding the Output Data](http://dev.datasift.com/docs/getting-started/data) page on the DataSift Developer site for
-full details of the data contained within each interaction.
-
Supported Operating Environment
-------------------------------
This version of the client library has been tested, and is known to work against the following language versions and Operating Systems:
### Language Versions
-* Ruby 1.9.3 (Seems to work, but NOT officially supported/thoroughly tested)
-* Ruby 2.0.0
+* Ruby 1.9.3 (Support for Ruby 1.x will be dropped from v4.0 of the library)
+* Ruby 2.0
* Ruby 2.1
* Ruby 2.2
### Operating Systems
* Linux
* Ubuntu
* OS X
* Windows 7/8
+Contributing
+------------
+Contributions are always welcome and appreciated
+
+1. Fork on GitHub
+2. Create a feature branch (we use [Gitflow](http://datasift.github.io/gitflow/IntroducingGitFlow.html) for branching)
+3. Commit your changes with tests
+ * New feature? Send a pull request against the develop branch.
+ * Bug fix? Send a pull request against the master branch.
+ * Please don't break backwards-compatibility :)
+
License
-------
-
All code contained in this repository is Copyright 2011-2015 MediaSift Ltd.
-This code is released under the BSD license. Please see the [LICENSE](https://github.com/datasift/datasift-ruby/blob/master/LICENSE) file for
-more details.
+This code is released under the BSD license. Please see the [LICENSE](https://github.com/datasift/datasift-ruby/blob/master/LICENSE) file for more details.