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.

Sign up for GitHub

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

Jump to bottom

Clarify the README that this is an IDL project and no binaries are distributed #72

Open
codefromthecrypt opened this issue Apr 30, 2019 · 0 comments
Open

Clarify the README that this is an IDL project and no binaries are distributed #72

codefromthecrypt opened this issue Apr 30, 2019 · 0 comments

Comments

@codefromthecrypt
Copy link
Member

In the last release vote, it seemed evident the README could be clarified in a couple ways.

  • beyond examples, further clarify that proto and swagger in this project are inputs to other tools
    • ex. point to the main docs of the IDL compiler
    • note that most users will not use these directly as tracing libraries will
  • address a frequently asked question which is "why is there a maven build?"
    • this is for java projects convenience to depend on the protos.
    • this is not a binary
    • this is an alternative to the source distribution, that only includes the proto file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@codefromthecrypt