Skip to content

Add high level differences between 1.x and 0.y to README #814

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 1 commit into from
May 27, 2020

Conversation

glbrntt
Copy link
Collaborator

@glbrntt glbrntt commented May 27, 2020

Motivation:

Modifications:

  • Add high level differences between two versions to README
  • Add current SemVer version build badge to make version more obvious
  • Explain difference between two example directories in README

Result:

Better documentation


This change is Reviewable

Motivation:

- There's been some confusion recently around the two versions of gRPC.
- See also: grpc#808

Modifications:

- Add high level differences between two versions to README
- Add current SemVer version build badge to make version more obvious
- Explain difference between two example directories in README

Result:

Better documentation
@glbrntt glbrntt added the 🔨 semver/patch No public API change. label May 27, 2020
@glbrntt glbrntt requested a review from MrMage May 27, 2020 08:50
Copy link
Collaborator

@MrMage MrMage left a comment

Choose a reason for hiding this comment

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

That's great, thank you!

Ideally, we would also have a dedicated guide on how to switch, but I guess that'll have to wait due to bandwidth concerns... (I also haven't experienced the transition on the client side myself yet, so can't report on that.)

Reviewed 1 of 1 files at r1.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved

@glbrntt
Copy link
Collaborator Author

glbrntt commented May 27, 2020

Ideally, we would also have a dedicated guide on how to switch, but I guess that'll have to wait due to bandwidth concerns... (I also haven't experienced the transition on the client side myself yet, so can't report on that.)

Agreed, I didn't have time to do all of that, but this felt like a lot of benefit for little effort.

@glbrntt glbrntt merged commit c1469e7 into grpc:master May 27, 2020
@glbrntt glbrntt deleted the gb-update-readme branch August 5, 2020 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 semver/patch No public API change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants