Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: organize README badges and remove TS example #112

Merged
merged 2 commits into from
May 4, 2020

Conversation

grant
Copy link
Member

@grant grant commented May 1, 2020

This PR organizes the README header and makes incremental improvements to the README aimed at people skimming it for the first time.

  • Reduce Badges to fit in one line
  • Change project title
  • Remove logo that isn't seen in other SDKs
  • Remove TypeScript example from main README.
  • Organize some headers to show code first

Signed-off-by: Grant Timmerman <timmerman+devrel@google.com>
@grant grant requested a review from lance May 1, 2020 18:44
@grant grant self-assigned this May 1, 2020
@fabiojose
Copy link
Contributor

Why remove ts examples and types?

@grant
Copy link
Member Author

grant commented May 1, 2020

Why remove ts examples and types?

The TS example and types are in the examples folder like the other samples: Express, Payload, and TypeScript. Including it in the README means we need to remember to update it in two places. Also, we're going to use objects, not builders soon with #65.

@helio-frota helio-frota self-requested a review May 4, 2020 12:53
Copy link
Contributor

@helio-frota helio-frota left a comment

Choose a reason for hiding this comment

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

LGTM.

@grant grant merged commit 07323e0 into master May 4, 2020
@grant grant deleted the grant_readme_header_structure branch May 4, 2020 17:33
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants