Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates README.md #29

Merged
merged 3 commits into from Oct 22, 2017
Merged

Updates README.md #29

merged 3 commits into from Oct 22, 2017

Conversation

ahamilton55
Copy link
Contributor

  • Moves logo to the top
  • Adds badges
  • Updates some heading levels
  • Fixes some markdown linting issues

Resolves #28

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 20, 2017
@SendGridDX
Copy link

SendGridDX commented Oct 20, 2017 •
edited

CLA assistant check
All committers have signed the CLA.

mbernier
mbernier suggested changes Oct 21, 2017
View reviewed changes
README.md
[![BuildStatus](https://travis-ci.org/sendgrid/smtpapi-go.svg?branch=master)](https://travis-ci.org/sendgrid/smtpapi-go)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.txt)
[![Email Notifications Badge](https://dx.sendgrid.com/badge/php)](https://dx.sendgrid.com/newsletter/php)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just learned about something neat! Can you please add these too?

[![Go Report Card](https://goreportcard.com/badge/github.com/sendgrid/smtpapi-go)](https://goreportcard.com/report/github.com/sendgrid/smtpapi-go)
[![GoDoc](https://godoc.org/github.com/sendgrid/smtpapi-go?status.svg)](https://godoc.org/github.com/sendgrid/smtpapi-go)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Fixed merge conflict with SEO changes too.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thank you!

mbernier
mbernier suggested changes Oct 22, 2017
View reviewed changes
Copy link

@mbernier mbernier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We really appreciate the help on this one! I apologize about the back and forth. We're nearly done!

README.md Outdated
* [Quick Start](#quick_start)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [How to Contribute](#contribute)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please modify this link to be #how-to-contribute (this is what GH auto-linked the header)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

README.md Outdated

* [Announcements](#announcements)
* [Installation](#installation)
* [Quick Start](#quick_start)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please modify this to #quick-start? This is how GH auto-linked the header

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@mbernier mbernier added difficulty: medium fix is medium in difficulty hacktoberfest labels Oct 22, 2017
@ahamilton55
Updates README.md
1188b62 
- Moves logo to the top
- Adds badges
- Updates some heading levels
- Fixes some markdown linting issues
@ahamilton55
Adds badges for GoDoc and Go Report Card
9636ab2 
- Adds GoDoc badge
- Adds Go Report Card badge
@ahamilton55
Fixes links in README.md with proper names
7affa9c
@mbernier mbernier merged commit 13f0edd into sendgrid:master Oct 22, 2017
@thinkingserious
Copy link
Contributor

Hello @ahamilton55,

Thanks again for the PR!

We want to show our appreciation by sending you some swag. Could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

@mbernier
Copy link

@ahamilton55
If you are interested, we would love the opportunity to talk to you about Hacktoberfest and our API libraries.

Our agenda would be: Explore what you liked and is there anything we can do to improve?

You can grab a time on my calendar that works for you and we can have a chat on Google Hangout or Skype. If you prefer, you can email me using my GitHub username at my company’s domain.

Thank you so much,

Matt Bernier - @mbernier - SendGrid Developer Experience Product Manager
Elmer Thomas - @thinkingserious - SendGrid Developer Experience Engineer
@sendgrid

@ahamilton55
Copy link
Contributor Author

@mbernier Unfortunately, this was really just a low hanging fruit PR trying to get my feet wet during Hacktoberfest and get past some of my anxiety around contributing to projects. I've haven't actually used your product or the Go API library so I don't really have any experience data to add. Seems like a good product but I don't current work on anything that requires me to send out a lot of emails.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mbernier mbernier mbernier approved these changes

Assignees
No one assigned
Labels
difficulty: medium fix is medium in difficulty status: code review request requesting a community code review or review from Twilio
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@ahamilton55 @SendGridDX @thinkingserious @mbernier