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.

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

docs: Add USAGE.md #72

Merged
merged 2 commits into from
Oct 4, 2018
Merged

Conversation

ProZsolt
Copy link
Contributor

@ProZsolt ProZsolt commented Oct 1, 2018

Fixes #44

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master branch.
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation about the functionality in the appropriate .md file
  • I have added in line documentation to the code I modified

@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label Oct 1, 2018
Copy link
Contributor

@kplimack kplimack left a comment

Choose a reason for hiding this comment

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

@ProZsolt thank you for your contribution! I left a couple small requests for minor updates.

USAGE.md Outdated

## Initialization

```
Copy link
Contributor

Choose a reason for hiding this comment

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

add ruby code formatter
i.e.

 ```ruby
 <code>
 ....

USAGE.md Outdated
api_key_id = JSON.parse(response.body)['api_key_id']
```

<a name="put"></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

markdown automatically generates anchors to each header, you can remove all the html tags
[create an anchor](#anchors-in-markdown)

USAGE.md Outdated
puts response.headers
```

<a name="patch"></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

markdown automatically generates anchors to each header, you can remove all the html tags

USAGE.md Outdated
<a name="put"></a>
## PUT

```
Copy link
Contributor

Choose a reason for hiding this comment

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

add ruby formatter

USAGE.md Outdated
puts response.headers
```

<a name="post"></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

markdown automatically generates anchors to each header, you can remove all the html tags

USAGE.md Outdated
puts response.headers
```

<a name="delete"></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

markdown automatically generates anchors to each header, you can remove all the html tags

USAGE.md Outdated
- [PUT](#put)
- [PATCH](#patch)

<a name="get"></a>
Copy link
Contributor

Choose a reason for hiding this comment

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

markdown automatically generates anchors to each header, you can remove all the html tags

USAGE.md Outdated

#### GET Collection

```
Copy link
Contributor

Choose a reason for hiding this comment

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

ruby formatter

USAGE.md Outdated
<a name="post"></a>
## POST

```
Copy link
Contributor

Choose a reason for hiding this comment

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

ruby formatter

USAGE.md Outdated
<a name="patch"></a>
## PATCH

```
Copy link
Contributor

Choose a reason for hiding this comment

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

ruby formatter

@kplimack kplimack self-assigned this Oct 2, 2018
@SendGridDX
Copy link

SendGridDX commented Oct 2, 2018

CLA assistant check
All committers have signed the CLA.

@thinkingserious thinkingserious added status: ready for deploy code ready to be released in next deploy difficulty: easy fix is easy in difficulty hacktoberfest type: twilio enhancement feature request on Twilio's roadmap and removed status: code review request requesting a community code review or review from Twilio labels Oct 2, 2018
@thinkingserious
Copy link
Contributor

Hello @ProZsolt,

Thanks again for the PR!

It's HACKTOBERFEST! We want to show our appreciation by sending you some special Hacktoberfest swag. If you have not already, could you please fill out this form so we can send it to you? Thanks!

Team SendGrid DX

@thinkingserious thinkingserious merged commit efc7af6 into sendgrid:master Oct 4, 2018
@thinkingserious
Copy link
Contributor

Hello @ProZsolt,

Thanks again for the PR!

We noticed that you have earned 3 out of the 5 points needed to receive glorious SendGrid Hacktoberfest swag.

Please take a moment to checkout this link to find more issues to get you past the required threshold.

Also, please be sure that you have officially registered here.

Thank you and Happy Hacktobering!

Team SendGrid DX

@thinkingserious
Copy link
Contributor

Hello @ProZsolt,

Thanks again for the PR!

You have earned 3 out of the 5 points needed to receive glorious SendGrid Hacktoberfest swag.

Please take a moment to checkout this link to find more issues to get you past the required threshold or to simply continue the celebration.

Also, please be sure you have officially registered with us here by November 1, 2018 to qualify.

If you have any questions you can email us at [email protected].

Thank you and Happy Hacktobering!

Team SendGrid

@ProZsolt
Copy link
Contributor Author

ProZsolt commented Oct 31, 2018 via email

@thinkingserious thinkingserious changed the title Add USAGE.md docs: Add USAGE.md Jan 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy fix is easy in difficulty status: ready for deploy code ready to be released in next deploy type: twilio enhancement feature request on Twilio's roadmap
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Copy docs from a PR to create a USAGE.md file
4 participants