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

fixed #47: Moved REST API usage examples to /docs/usage.md #48

Merged
merged 4 commits into from Feb 24, 2019

Conversation

@jatinkumarg
Copy link
Contributor

commented Feb 23, 2019

Moved the REST API usage examples from the README.md to a /docs/usage.md.

docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
@nitishm
Copy link
Owner

left a comment

Just minor markdown header formatting

docs/usage.md Outdated Show resolved Hide resolved
@jatinkumarg

This comment has been minimized.

Copy link
Contributor Author

commented Feb 24, 2019

@nitishm Can you please review my new changes?

@nitishm

This comment has been minimized.

Copy link
Owner

commented Feb 24, 2019

@jatinkumarg it looks good now. I forgot to ask you to add a link to the docs in the README.md.

Under the subsection for Usage add a link to docs.md

@jatinkumarg

This comment has been minimized.

Copy link
Contributor Author

commented Feb 24, 2019

@nitishm you mean adding a Usage.md link to Readme.md ?

Can you also tell me how can I do it?

README.md Show resolved Hide resolved
@nitishm

This comment has been minimized.

Copy link
Owner

commented Feb 24, 2019

@nitishm you mean adding a Usage.md link to Readme.md ?

Can you also tell me how can I do it?

Sure, I added the suggestion for change in the README.md change review.

@jatinkumarg

This comment has been minimized.

Copy link
Contributor Author

commented Feb 24, 2019

@nitishm Thanks for the help!

I have made the required changes. Can you please review it?

README.md Outdated
]
```
### REST API
- (usage.md)[https://github.com/nitishm/vegeta-server/tree/master/docs/usage.md]

This comment has been minimized.

Copy link
@nitishm

nitishm Feb 24, 2019

Owner

Bah my bad. Always mix up the braces.

Suggested change
- (usage.md)[https://github.com/nitishm/vegeta-server/tree/master/docs/usage.md]
- [usage.md](https://github.com/nitishm/vegeta-server/tree/master/docs/usage.md)
@nitishm

This comment has been minimized.

Copy link
Owner

commented Feb 24, 2019

@jatinkumarg Sorry I mixed up the braces. Suggested the fix.

@jatinkumarg

This comment has been minimized.

Copy link
Contributor Author

commented Feb 24, 2019

@nitishm I have updated the brackets in README.md

@nitishm

This comment has been minimized.

Copy link
Owner

commented Feb 24, 2019

LGTM. Great job @jatinkumarg

@nitishm nitishm closed this Feb 24, 2019

@nitishm nitishm reopened this Feb 24, 2019

@nitishm nitishm merged commit 5cbc66e into nitishm:master Feb 24, 2019

2 of 3 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
GolangCI No issues found!
Details
coverage/coveralls Coverage increased (+19.5%) to 69.888%
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.