Documentation improvements (#133)

* Documentation improvements

* Adding suggestions from #62

* fixing contributors in readme

.gitignore

@@ -36,4 +36,5 @@ test/version_tmp
 tmp
 tmtags
 tramp
-vendor
+.vscode
+vendor

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# How to Contribute
+
+We'd love to get patches from you!
+
+## Getting Started
+
+We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/)
+
+1. Fork the project
+2. Check out the `master` branch
+3. Create a feature branch
+4. Write code and tests for your change
+5. From your branch, make a pull request against `twitter/twurl/master`
+6. Work with repo maintainers to get your change reviewed
+7. Wait for your change to be pulled into `twitter/twurl/master`
+8. Delete your feature branch
+
+## License
+
+By contributing your code, you agree to license your contribution under the
+terms of the MIT License: https://github.com/twitter/twurl/blob/master/LICENSE
+
+## Code of Conduct
+
+Read our [Code of Conduct](CODE_OF_CONDUCT.md) for the project.

README.md

@@ -1,6 +1,9 @@
 Twurl
 =====
 
+[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/twitter/twurl/blob/master/LICENSE)
+ [![Gem Version](https://badge.fury.io/rb/twurl.svg)](https://badge.fury.io/rb/twurl)
+
 Twurl is like curl, but tailored specifically for the Twitter API.
 It knows how to grant an access token to a client application for
 a specified user and then sign all requests with that access token.
@@ -10,34 +13,31 @@ as defining aliases for common requests, as well as support for
 multiple access tokens to easily switch between different client
 applications and Twitter accounts.
 
-
 Installing Twurl
 ----------------
 
-Twurl can be installed using ruby gems:
+Twurl can be installed using RubyGems:
 
-```
+```sh
 gem install twurl
 ```
 
-
 Getting Started
 ---------------
 
-If you haven't already, the first thing to do is apply for a developer account to access Twitter APIs: 
+If you haven't already, the first thing to do is apply for a developer account to access Twitter APIs:
 
-```
+```text
 https://developer.twitter.com/en/apply-for-access
 ```
-
-After you have that access you can create a Twitter app and generate a consumer key and secret.  
-
+
+After you have that access you can create a Twitter app and generate a consumer key and secret.
 
 When you have your consumer key and its secret you authorize
-your Twitter account to make API requests with your consumer key
+your Twitter account to make API requests with that consumer key
 and secret.
 
-```
+```sh
 twurl authorize --consumer-key key       \
                 --consumer-secret secret
 ```
@@ -47,14 +47,13 @@ Authenticate to Twitter, and then enter the returned PIN back into
 the terminal.  Assuming all that works well, you will be authorized
 to make requests with the API. Twurl will tell you as much.
 
-
 Making Requests
 ---------------
 
 The simplest request just requires that you specify the path you
 want to request.
 
-```
+```sh
 twurl /1.1/statuses/home_timeline.json
 ```
 
@@ -63,47 +62,61 @@ Similar to curl, a GET request is performed by default.
 You can implicitly perform a POST request by passing the -d option,
 which specifies POST parameters.
 
-```
+```sh
 twurl -d 'status=Testing twurl' /1.1/statuses/update.json
 ```
 
 You can explicitly specify what request method to perform with
 the -X (or --request-method) option.
 
-```
+```sh
 twurl -X POST /1.1/statuses/destroy/1234567890.json
 ```
 
+Accessing Different Hosts
+-------------------------
+
+You can access different hosts for other Twitter APIs using the -H flag.
+
+```sh
+twurl -H "ads-api.twitter.com" "/5/accounts"
+```
+
+Uploading Media
+---------------
+
+To upload binary files, you can format the call as a form post. Below, the binary is "/path/to/media.jpg" and the form field is "media":
+
+```sh
+twurl -H "upload.twitter.com" -X POST "/1.1/media/upload.json" --file "/path/to/media.jpg" --file-field "media"
+```
 
 Creating aliases
 ----------------
 
-```
+```sh
 twurl alias h /1.1/statuses/home_timeline.json
 ```
 
 You can then use "h" in place of the full path.
 
-```
+```sh
 twurl h
 ```
 
-Paths that require additional options such as request parameters for example can
-be used with aliases the same as with full explicit paths, just as you might
-expect.
+Paths that require additional options (such as request parameters, for example) can be used with aliases the same as with full explicit paths, just as you might expect.
 
-```
+```sh
 twurl alias tweet /1.1/statuses/update.json
 twurl tweet -d "status=Aliases in twurl are convenient"
 ```
 
-
 Changing your default profile
 -----------------------------
 
 The first time you authorize a client application to make requests on behalf of your account, twurl stores your access token information in its .twurlrc file. Subsequent requests will use this profile as the default profile. You can use the 'accounts' subcommand to see what client applications have been authorized for what user names:
 
-```
+```sh
 twurl accounts
   noradio
     HQsAGcBm5MQT4n6j7qVJw
@@ -114,7 +127,7 @@ twurl accounts
 
 Notice that one of those consumer keys is marked as the default. To change the default use the 'set' subcommand, passing then either just the username, if it's unambiguous, or the username and consumer key pair if it isn't unambiguous:
 
-```
+```sh
 twurl set default testiverse
 twurl accounts
   noradio
@@ -124,7 +137,7 @@ twurl accounts
     guT9RsJbNQgVe6AwoY9BA (default)
 ```
 
-```
+```sh
 twurl set default noradio HQsAGcBm5MQT4n6j7qVJw
 twurl accounts
   noradio
@@ -137,7 +150,7 @@ twurl accounts
 Contributors
 ------------
 
-Marcel Molina <[email protected]> / @noradio  
+Marcel Molina / @noradio
 Erik Michaels-Ober / @sferik
 
 and there are many [more](https://github.com/twitter/twurl/graphs/contributors)!

twurl.gemspec

@@ -5,11 +5,10 @@ require 'twurl/version'
 
 Gem::Specification.new do |spec|
   spec.add_dependency 'oauth', '~> 0.4'
-  spec.authors = ["Marcel Molina", "Erik Michaels-Ober"]
+  spec.authors = ["Marcel Molina", "Erik Michaels-Ober", "@TwitterDev team"]
   spec.description = %q{Curl for the Twitter API}
-  spec.email = ['[email protected]']
   spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  spec.extra_rdoc_files = %w(CODE_OF_CONDUCT.md INSTALL.md LICENSE README.md)
+  spec.extra_rdoc_files = %w(CODE_OF_CONDUCT.md CONTRIBUTING.md INSTALL LICENSE README.md)
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.start_with?('test/') }
   spec.homepage = 'http://github.com/twitter/twurl'
   spec.licenses = ['MIT']