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.

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

chore: update README for web site inclusion #104

Merged
merged 4 commits into from
Dec 5, 2023
Merged

Conversation

toddbaert
Copy link
Member

This PR:

I've tried to get everything right, but there's 5-6 code-example TODOs.

@beeme1mr feel free to make any corrections you see. Up to you if you think we can include this without the code samples.

@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (ea4fed3) 95.19% compared to head (a3be183) 95.19%.

Additional details and impacted files
@@            Coverage Diff            @@
##               main     #104   +/-   ##
=========================================
  Coverage     95.19%   95.19%           
  Complexity      227      227           
=========================================
  Files            40       40           
  Lines           583      583           
=========================================
  Hits            555      555           
  Misses           28       28           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@beeme1mr
Copy link
Member

We may need to add a fourth status to denote features that don't make sense in a language. I think that may be the case for php. What do you think @tcarrio?

README.md Outdated Show resolved Hide resolved
@toddbaert
Copy link
Member Author

We may need to add a fourth status to denote features that don't make sense in a language. I think that may be the case for php. What do you think @tcarrio?

Potentially dumb question, but what feature(s) wouldn't exist in PHP... shutdown?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@beeme1mr beeme1mr linked an issue Nov 1, 2023 that may be closed by this pull request
toddbaert and others added 4 commits December 4, 2023 23:04
Signed-off-by: Todd Baert <[email protected]>
Signed-off-by: Tom Carrio <[email protected]>
Co-authored-by: Tom Carrio <[email protected]>
Signed-off-by: Todd Baert <[email protected]>
Signed-off-by: Tom Carrio <[email protected]>
Signed-off-by: Michael Beemer <[email protected]>
Signed-off-by: Tom Carrio <[email protected]>
@tcarrio
Copy link
Member

tcarrio commented Dec 5, 2023

Added the missing code examples, rebased on the latest main, and signed off all commits.

@beeme1mr beeme1mr merged commit 5d393b5 into main Dec 5, 2023
7 checks passed
@toddbaert toddbaert deleted the chore/readme-update branch December 5, 2023 14:16
tcarrio pushed a commit that referenced this pull request Dec 17, 2023
🤖 I have created a release *beep* *boop*
---


##
[2.0.4](2.0.3...2.0.4)
(2023-12-05)


### 🧹 Chore

* **deps:** update dependency vimeo/psalm to ~5.17.0
([#111](#111))
([ea4fed3](ea4fed3))
* update README for web site inclusion
([#104](#104))
([5d393b5](5d393b5))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

[DOC] Update readme to follow new template
3 participants