docs: improve README - #84
Conversation
| [](https://github.com/reponomics/PolicyChecks/actions/workflows/ci.yml) | ||
| [](https://scorecard.dev/viewer/?uri=github.com/reponomics/PolicyChecks) | ||
| [](LICENSE) | ||
| [](.nvmrc) | ||
| [](https://github.com/apps/policychecks) |
There was a problem hiding this comment.
good - i like this - i was stuffing all the PolicyChecks badges up to the top because that's the product but it wasn't pretty - the question for me is how to maintain the app badges as the main focus without a wall of badges at the top - so if we decide to use other badges at the top they have to be very purposeful - some of these don't buy their worth for me (e.g. node version - that's good to document but I don't know if i want a badge up top.
do you see what I'm getting at? OSSF Scorecard is meaningful - the GitHub App install link is useful - the others i'm not sure are top-of-page badgeworthy - i'm going to register with CII Best Practices as well so we can add that (that's meaningful).
Need to think more on this - I agree with the general move though
There was a problem hiding this comment.
yep, i get you. i agree the top should only have badges that are actually worth showing there, while the PolicyChecks badges stay the main focus. i’ll keep it minimal for now and we can add CII once it’s registered.
2 participants
Summary
Improve the README for better clarity, onboarding, and documentation.
No functionality changes.