Readme #33
Merged
Readme #33
Conversation
This file contains hidden or 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
qinfchen
reviewed
Jul 9, 2018
| @@ -0,0 +1,19 @@ | |||
| # Contributing | |||
|
|
|||
| The team welcomes contributions! To make changes: | |||
readme.md
Outdated
|
|
||
| ## Usage | ||
|
|
||
| The recommended way to use conjure-java is via a build tool like [gradle-conjure](https://github.com/palantir/gradle-conjure). However, if you don't want to use gradle-conjure, there is also a executable which conforms to [RFC 002](https://github.com/palantir/conjure/blob/develop/rfc/002-contract-for-conjure-generators.md), published on [bintray](https://bintray.com/palantir/releases/conjure-java). |
readme.md
Outdated
|
|
||
| Usage: conjure-java generate <input> <output> [...options] | ||
|
|
||
| --objects Generate POJOs for Conjure type definitions |
Contributor
There was a problem hiding this comment.
add note that these are boolean flags?
readme.md
Outdated
| - **Conjure alias: [StringAliasExample](./conjure-java-core/src/integrationInput/java/com/palantir/product/StringAliasExample.java)** | ||
| Aliases have exactly the same JSON representation as their inner type, so they are useful for making error-prone function signatures more more bulletproof: |
readme.md
Outdated
|
|
||
| ## Example Retrofit interfaces | ||
|
|
||
| As an alternative to the JAX-RS interfaces above, conjure-java can generate equivalent interfaces with [Retrofit2](http://square.github.io/retrofit/) annotations. These clients are useful if you to to stream binary data or make non-blocking async calls: |
Contributor
There was a problem hiding this comment.
"to to stream"" > "want to stream"
| Call<ResponseBody> binary(@Header("Authorization") AuthHeader authHeader); | ||
| ``` | ||
|
|
||
| You can also supply the `--retrofitCompletableFutures` flag if you prefer Java 8 CompletableFutures instead of OkHttp's Call. |
Contributor
There was a problem hiding this comment.
should this be included in the usage?
Contributor
Author
There was a problem hiding this comment.
It messes up all the indenting and seemed a bit unimportant
qinfchen
approved these changes
Jul 9, 2018
qinfchen
reviewed
Jul 9, 2018
readme.md
Outdated
|
|
||
| You can also supply the `--retrofitCompletableFutures` flag if you prefer Java 8 CompletableFutures instead of OkHttp's Call. | ||
| ## Local development |
Contributor
There was a problem hiding this comment.
i think this is Contribution section
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
No useful information on README.
After this PR
README describes design decisions and intended usage of conjure-java objects, and links to other conjure-ecosystem projects.