README.md in rdstation-ruby-client-0.0.4 vs README.md in rdstation-ruby-client-0.0.5
- old
+ new
@@ -1,8 +1,8 @@
-# Rdstation::Ruby
+# RDStation Ruby Client
-TODO: Write a gem description
+RDstation ruby wrapper to interact with RDStation API.
## Installation
Add this line to your application's Gemfile:
@@ -17,28 +17,48 @@
$ gem install rdstation-ruby-client
## Usage
### Creating a Lead
- rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
- rdstation_client.create_lead({:email => 'joe@foo.bar', :nome => 'Joe Foo', :empresa => 'A random Company', :cargo => 'Developer', identificador: 'nome_da_conversao'})
+```ruby
+lead_info = {
+ email: 'joe@foo.bar',
+ name: 'Joe foo',
+ empresa: 'A random Company',
+ cargo: 'Developer',
+ identificador: 'nome_da_conversao'
+}
+
+rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
+rdstation_client.create_lead(lead_info)
+```
+
### Changing a Lead
- rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
- rdstation_client.change_lead('joe@foo.bar', {:lifecycle_stage => 1, :opportunity => true})
+```ruby
+rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
+rdstation_client.change_lead('joe@foo.bar', lifecycle_stage: 1, opportunity: true})
+```
+
### Change Lead Status
- rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
- rdstation_client.change_lead_status(email: 'joe@foo.bar', status: 'won', value: 999)
+```ruby
+rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
+rdstation_client.change_lead_status(email: 'joe@foo.bar', status: 'won', value: 999)
+```
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Maintainer
+[Nando Sousa](mailto:fernando.sousa@resultadosdigitais.com.br)
## Reference
You can check out RDstation's integration (pt-BR) documentation here: