README.md in outreach-0.0.2 vs README.md in outreach-0.1.0
- old
+ new
@@ -37,11 +37,11 @@
Outreach::Authorization.authorization_url
```
For example, if using Rails this could be in a view
```
- <%= link_to("Connect to Outreach", Outreach::Authorization.authorization_url)
+ <%= link_to("Connect to Outreach", Outreach::Authorization.authorization_url) %>
```
This will take the user through the oauth process - afterwards they will be redirected back to your site to whatever the url you have setup in Outreach.redirect_uri. This will also provide the authorization key so you can get access for that user using the Outreach::Authorization.create method.
Here's a Rails example:
@@ -75,37 +75,37 @@
```
## API Client
Once you have the access code for a user you can then create an api client for that user.
```ruby
- client = Outreach::Client.new(user.access_code)
+ outreach = Outreach::Client.new(user.access_code)
```
## Prospects
To find all prospects:
```ruby
- client.prospects.all
+ outreach.prospects.find_all
# returns an array of prospects
```
Filtering is possible by using the following conditions:
```ruby
# first_name
# last_name
# email
# company_name
# e.g.
- client.prospects.all({ first_name: "Chris", last_name: "O'Sullivan" })
+ outreach.prospects.find_all({ first_name: "Chris", last_name: "O'Sullivan" })
```
-The results of client.prospects.all is paginated. You can control pagination by passing in which page you want to see:
+The results of outreach.prospects.find_all is paginated. You can control pagination by passing in which page you want to see:
```ruby
- client.prospects.all({ page: 2 })
+ outreach.prospects.find_all({ page: 2 })
```
You can find a specific prospect given the prospect id:
```ruby
- clients.prospect.find(2345)
+ outreach.prospects.find(2345)
```
## Contributing
1. Fork it ( https://github.com/[my-github-username]/outreach/fork )