Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ejholmes committed Apr 26, 2012
1 parent 3a12b93 commit f89a7dc
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Expand Up @@ -16,6 +16,9 @@ And then execute:

### Configuration

In order to make more than 100 requests/hour you need to [register](http://octopart.com/api/signin?continue_to=http%3A//octopart.com/api/register)
your application with Octopart and obtain your API key. Once you have your API key, you can set it like so.

```ruby
Octopart.configure do |config|
config.apikey = 'your api key'
Expand All @@ -24,6 +27,8 @@ end

### Parts

* * *

**#find**

Find a part by it's octopart ID.
Expand All @@ -39,6 +44,8 @@ part.mpn
# => "H-46-6A"
```

* * *

**#search**

Search all parts that match a given query string.
Expand All @@ -51,6 +58,8 @@ Octopart::Part.search('resistor', limit: 10)
# => [<Octopart::Part >, ... ]
```

* * *

**#match**

Match (manufacturer name, mpn) to part uid.
Expand All @@ -60,6 +69,8 @@ Octopart::Part.match('texas instruments', 'SN74LS240N')
# => 42315325996
```

* * *

**#bom**

Return an array of parts that match the criteria
Expand Down

0 comments on commit f89a7dc

Please sign in to comment.