Revamp readme

Open cmaneu opened this issue 3 years ago • 1 comments

Our current readme is a little scarce. We should revamp it so it's more useful, contains better info (for people discovering the projet through GitHub and not the website).

Contents to include:

Quick description
A gif of the CLI?
Who uses it?
Relevant badges
Quick access to releases (CLI and Docker image)
Contributor guideline
License
How to contact authors

This issue is a bit linked to #33, as some content will be moved to the new documentation.

Jan 28 '22 10:01 cmaneu

Inspiration:

https://github.com/getporter/porter/blob/main/README.md: Includes cool tabs (to see what's supported, we can do this for Bicep/Terraform for example), and a roadmap section
https://github.com/explosion/spaCy/blob/master/README.md: Clean "features" section, love the "where to ask questions"

Feb 04 '22 08:02 cmaneu