updated Readme

Dylan Montgomery committed Jun 03, 2015

commit e070fadc35759dd7324a1516d14cc1117a1c0e34

Showing 1 changed file with 84 additions and 5 deletions

README.md +84 -5

@@	@@ -1,6 +1,6 @@
	# Bidsketch

-	TODO: Write a gem description
+	The bidsketch gem is a ruby wrapper for interacting with the [Bidsketch API](https://github.com/Bidsketch/bidsketch-api).

	## Installation

@@	@@ -18,14 +18,93 @@ Or install it yourself as:

	$ gem install bidsketch

-	## Usage
+	## Getting Started

-	TODO: Write usage instructions here
+	You will need a Bidsketch API key. For instructions on finding your API key: http://help.bidsketch.com/article/76-using-the-bidsketch-api
+
+	## Authentication
+
+	```ruby
+	Bidsketch.api_key = 'YOUR API KEY'
+	```
+	Alternatively you can set your API key as an environment variable:
+
+	```ruby
+	ENV['BIDSKETCH_API_KEY'] = 'YOUR API KEY'
+	```
+	## Clients
+	To get all clients:
+
+	```ruby
+	Bidsketch::Client.all
+	```
+
+	To get a particular client:
+
+	```ruby
+	Bidsketch::Client.find(id)
+	```
+
+	## Fees
+
+	To get all fees:
+
+	```ruby
+	Bidsketch::Fee.all
+	```
+
+	To get a particular fee:
+
+	```ruby
+	Bidsketch::Fee.find(id)
+	```
+
+	## Proposals
+
+	To get all proposals:
+
+	```ruby
+	Bidsketch::Proposal.all
+	```
+
+	To get a particular proposal:
+
+	```ruby
+	Bidsketch::Proposal.find(id)
+	```
+
+	## Sections
+
+	To get all sections
+
+	```ruby
+	Bidsketch::Section.all
+	```
+
+	To get a particular section:
+
+	```ruby
+	Bidsketch::Section.find(id)
+	```
+
+	## Templates
+
+	To get all templates:
+
+	```ruby
+	Bidsketch::Template.all
+	```
+
+	To get a particular template:
+
+	```ruby
+	Bidsketch::Template.find(id)
+	```

	## Contributing

-	1. Fork it ( https://github.com/[my-github-username]/bidsketch/fork )
+	1. Fork it ( https://github.com/citizens/bidsketch-ruby/fork )
	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 a new Pull Request
+	5. Create a new Pull Request
	\ No newline at end of file