Skip to content

Update README.md #276

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

Merged
merged 4 commits into from
Oct 12, 2022
Merged

Conversation

AdrielBento
Copy link
Contributor

  • Fix Travis url badge
  • Add new badges
  • Add table of contents
  • Change TODO to Features
  • Remove sponsor section

@@ -108,12 +120,6 @@ Check [examples](examples) and [interop](interop)(Interoperability Test) for som

2. [Benchmark](benchmark) followed by official spec

## Sponsors
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this sponsorship still going on? If not, I think it makes more sense to remove that section.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure. I think @tony612 is the best person to answer this

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's okay to remove this.

@@ -83,21 +98,18 @@ iex> {:ok, channel} = GRPC.Stub.connect("localhost:50051", interceptors: [GRPC.L

Check [examples](examples) and [interop](interop)(Interoperability Test) for some examples.

## TODO
## Features
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that all the items on the list are done, I think it makes more sense to turn this section into a list of implemented features.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this section altogether instead.
Or add a less itemized version in its place

Copy link
Contributor Author

@AdrielBento AdrielBento Oct 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a less itemized version in its place

I agree with you. What kind of items can we keep or what features are important to mention in the documentation? @polvalente

Copy link
Collaborator

@sleipnir sleipnir Oct 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a less itemized version in its place

I agree with you. What kind of items can we keep or what features are important to mention in the documentation? @polvalente

Supported request types (unary, stream in, stream out, bid stream), encoding types (grpc+web, grpc. etc), transport types (uds, tcp, tls), grpc reflection (in progress) , http transcoding... I think are important things

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't add anything that's still in progress. Otherwise, I agree with @sleipnir

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't add anything that's still in progress. Otherwise, I agree with @sleipnir

It was not my intention to say to put whatever is in progress. Just present an overview of what are the interesting features of any grpc library.

@AdrielBento AdrielBento marked this pull request as ready for review October 1, 2022 10:23
@polvalente polvalente merged commit ff166c1 into elixir-grpc:master Oct 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants