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

Update README.md #90

Open
madhavajay opened this issue Apr 23, 2020 · 0 comments
Open

Update README.md #90

madhavajay opened this issue Apr 23, 2020 · 0 comments

Comments

@madhavajay
Copy link
Contributor

Can we do this for:

covidwatch-ios
covidwatch-ios-minimal
tcn-client-ios
We want the following out of our README.md

How to Setup

This is the "Onboarding from scratch" for anyone new to read and should work
Explanation of what it does

How it interfaces with other COVIDWatch / external repos

How testing works

How to Contribute

Style guides etc
Badges
Lets add some cool badges:
https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8

FAQ
When people are unsure lets populate this with some obvious answers

Contributors / Contacts

Link to the COVIDWatch Slack or how to email to get access / invites
@name's of people you can contact for help regarding the project.

Heres an example of some stuff I did in the cloud functions readme:

https://github.com/covid19risk/covidwatch-cloud-functions

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

No branches or pull requests

1 participant