Clarify the README that this is an IDL project and no binaries are distributed · Issue #72 · openzipkin/zipkin-api · GitHub
Skip to content

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

Open

Description

@codefromthecrypt

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions