How should the opensource projects readme look like?

All opensource projects must have similiar README; as it will be a source of "attraction"

So, we need to define a format and then ensure its followed:

We should have following sections

Different icons e.g. build, version, tech, docker downloads?

you can look in references for inspirations

e.g. https://github.com/jtblin/kube2iam#kube2iam

e.g. https://github.com/jtblin/kube2iam#context

e.g.https://github.com/jtblin/kube2iam#problem-statement

e.g. https://github.com/jtblin/kube2iam#solution

What technology stack has been used

If it has backend then what technologies have been used at different layers?

If it is frontend then what technologies have been used?

How it can be deployed? docker or not?

How was testing done? Put numbers e.g.

1. Number of automated tests?

How was security implemented?

If it has frontend; then run it and add screen shots.

How to run it?

How to build it?

e.g. https://github.com/cloudposse/bastion#usage or https://github.com/jtblin/kube2iam#usage

NOTE From 6 to 10 they will be generic!

e.g. https://github.com/cloudposse/bastion#help

e.g. https://github.com/cloudposse/bastion#contributing

e.g. https://github.com/cloudposse/bastion#change-log

e.g. https://github.com/cloudposse/bastion#license

https://github.com/cloudposse/bastion#about THIS MUST HAVE AN IMAGE LIKE THIS ONE https://github.com/AngularClass/angular-starter#netlify

Look these for inspirations:

• https://github.com/cloudposse/bastion
• https://github.com/AngularClass/angular-starter
• https://github.com/jtblin/kube2iam