add documentation #14
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iamdanfox
reviewed
Jul 4, 2018
README.md
Outdated
|
|
||
| __Browser compatibility__: This library uses ES6 features (namely, fetch). Ensure that your runtime environment supports ES6 features. | ||
| conjure-typescript-client leverages [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to provide a | ||
| simple interface for making HTTP requests. Its intended usage is as a conveniences library to simplify code generated by |
There was a problem hiding this comment.
Can we change the intended usage bit pls - don't really like the implication that the conjure-typescript generated code needs simplifying!!
iamdanfox
reviewed
Jul 4, 2018
README.md
Outdated
| } | ||
| }) | ||
|
|
||
| bridge.callEndpoint({ |
There was a problem hiding this comment.
Maybe a little comment to say conjure-typescript generates this code?
There was a problem hiding this comment.
I don't think we want that. This is a standalone library, and we're describing how to use it as such.
iamdanfox
reviewed
Jul 4, 2018
| @@ -6,7 +6,7 @@ | |||
| "main": "lib/index.js", | |||
| "typings": "lib/index.d.ts", | |||
| "scripts": { | |||
| "build": "npm-run-all clean lint compile", | |||
| "build": "npm-run-all clean lint compile test", | |||
added 2 commits
July 4, 2018 11:54
iamdanfox
approved these changes
Jul 8, 2018
bavardage
pushed a commit
to bavardage/conjure-typescript-runtime
that referenced
this pull request
Jul 24, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this PR
Very little documentation
After this PR
Fleshed out README and CONTRIBUTING documents