README Fixes
Ademsk1 opened this issue · 1 comments
Ademsk1 commented
Using issues to divvy this work up. First off is the README which needs some love.
Cleanup
- CI badge template link needs to be the plugin link, as opposed to the hub-template link
- Casing consistency of title. Let's use "playwright-firebase" as the title.
- Fix yarn install name, it's not right
- Use
tsto highlight all the code - Spacing in code e.g.
{Credentials} => { Credentials }and new lines between imports and code. - Various grammatical error scan. (e.g. Create a setup file that is ran)
Secondly, the README in general doesn't quite make sense. The flow isn't quite right. We should assume the user is someone who is somewhat familiar with Firebase and Playwright. But the flow assumes a lot more (as if they wrote the plugin themselves 🤔 )
Content flow
- Placing the commands at the top without any context
- No clear explanation of SERVICE_ACCOUNT, UID or FIREBASE_CONFIG. Also do these have REACT_APP prefixes?
- Links to related Google Firebase pages would also be helpful.
- Clarify why we use 10.5.0 Firebase for the auth. Is it even worth adding this in?
- More clarity on the setup file. What's it doing? What's the context?
I'm going to create another issue about creating a Sample application within this repo so it hopefully makes more sense. Let's do that first, and then we can add more to the README about how to setup the sample application.
github-actions commented