search

sendgrid / ruby-http-client

SendGrid's Ruby HTTP Client for calling APIs
https://sendgrid.com
MIT License
23 stars 54 forks source link

Copy docs from a PR to create a USAGE.md file #44

Closed mbernier closed 6 years ago

mbernier commented 7 years ago

Issue Summary

Usage files are really nice when they exist in a repo, because it makes it really obvious where to look for information about how to use this tool. It can be frustrating when you expect this file to be there and it's not. Please add a USAGE.md file, you can see an example of this here

Please make sure you modify the file for this repo (hint: Most of this information should be in the README file)

Also, @fifiteen82726 put together some AWESOME docs for how to install and run codeclimate locally, including a gif. Please add this to your new USAGE.md file.

astromoose commented 7 years ago

I’d love to help ;)

williamn commented 7 years ago

hi @astromoose are you working on this? If not, I'd happy to send a PR

astromoose commented 7 years ago

I was, yeah - but sadly RealWork™ has got in the way since :) go for it!

On 30. Oct 2017, at 11:22, William Notowidagdo notifications@github.com wrote:

hi @astromoose are you working on this? If not, I'd happy to send a PR

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

williamn commented 7 years ago

@astromoose sadly that's what happening to me now. I won't make to send a PR