Skip to content

Chore: Bring Readme inline with project readme template #128

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

Closed
wants to merge 2 commits into from

Conversation

jamescarr
Copy link
Contributor

This PR

  • Clean up readme to bring it inline with project standards
  • Add examples

Related Issues

Fixes #100

Notes

Follow-up Tasks

How to test

@codecov
Copy link

codecov bot commented Jun 28, 2023

Codecov Report

Merging #128 (0e0ace6) into main (0eb8eff) will increase coverage by 0.15%.
The diff coverage is 100.00%.

❗ Current head 0e0ace6 differs from pull request most recent head d5026b8. Consider uploading reports for the commit d5026b8 to get more accurate results

@@            Coverage Diff             @@
##             main     #128      +/-   ##
==========================================
+ Coverage   92.93%   93.09%   +0.15%     
==========================================
  Files          20       20              
  Lines         354      362       +8     
==========================================
+ Hits          329      337       +8     
  Misses         25       25              
Flag Coverage Δ
unittests 93.09% <100.00%> (+0.15%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...feature/flag_evaluation/flag_evaluation_details.py 100.00% <100.00%> (ø)
open_feature/flag_evaluation/reason.py 100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@jamescarr jamescarr force-pushed the chore-cleanup-readme branch 2 times, most recently from 7372c7e to d35ff6b Compare June 28, 2023 20:54
@jamescarr jamescarr changed the title Bring Readme inline with project readme template Chore: Bring Readme inline with project readme template Jun 28, 2023
@jamescarr jamescarr marked this pull request as ready for review June 28, 2023 20:56
@jamescarr jamescarr marked this pull request as draft June 28, 2023 20:56
@jamescarr jamescarr force-pushed the chore-cleanup-readme branch from cfc607f to d639612 Compare June 28, 2023 20:57
@jamescarr jamescarr marked this pull request as ready for review June 28, 2023 20:58
renovate bot and others added 2 commits June 28, 2023 16:03
…ure#123)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Signed-off-by: James Carr <[email protected]>
@jamescarr jamescarr force-pushed the chore-cleanup-readme branch from 0e0ace6 to d5026b8 Compare June 28, 2023 21:04
@jamescarr
Copy link
Contributor Author

Ooof, messed up a little on this one, will re-open.

@jamescarr jamescarr closed this Jun 28, 2023
@jamescarr jamescarr deleted the chore-cleanup-readme branch June 28, 2023 21:05
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.

Add comprehensive and consistent readme
1 participant