-
Notifications
You must be signed in to change notification settings - Fork 94
Reorg repo and README #105
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
Conversation
a few pointers from Irene
|
README.md
Outdated
|
||
See [swagger-js](https://github.com/swagger-api/swagger-js) | ||
See [CONTRIBUTING.md#go-client](CONTRIBUTING.md) for details on how this client is developed and generated. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need #go-client
here (looks like it's not really pointing to anywhere specifically in contributing)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixing
README.md
Outdated
@@ -1,47 +1,39 @@ | |||
# Netlify open-api | |||
# open-api | |||
[](https://travis-ci.org/netlify/open-api) [](https://ci.appveyor.com/project/netlify/open-api/branch/master) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we have a new line for each status? I think it still renders the same way
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixing
Left some comments but overall I like this change a lot! |
README.md
Outdated
Swagger's JS client can dynamically create a client from a spec either from a URL or spec object. | ||
- [Porcelain](https://godoc.org/github.com/netlify/open-api/go/porcelain): High level interactions and operations | ||
- [Plumbing](https://godoc.org/github.com/netlify/open-api/go/plumbing): Low level client operations | ||
- [Models](https://godoc.org/github.com/netlify/open-api/go/porcelain): Models generated by [go-swagger]() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
link is missing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixing
README.md
Outdated
|
||
Swagger's JS client can dynamically create a client from a spec either from a URL or spec object. | ||
- [Porcelain](https://godoc.org/github.com/netlify/open-api/go/porcelain): High level interactions and operations | ||
- [Plumbing](https://godoc.org/github.com/netlify/open-api/go/plumbing): Low level client operations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe add "generated by go-swagger" here as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixing
Thanks for the review @keiko713 ! I'll incorporate these changes. |
Okiedoke, this should be good now. |
Here are some ideas I had to reorganize this repo.