Describe the solution you'd like
Change our readme structure to something more descriptive.
What is the added value?
A more descriptive readme would help people get a better sense of the project at first glance.
Give us examples of the outcome
Maybe something following this structure:
Title
Badges
Description
Features
How to run the tests
AwsSM getting started
Link to other Backend docs
Link to contributing
And we can have specific readmes for the other backends. I prefer to have a getting started with the most popular backend (AWS Secret Manager) in the readme, so with the readme itself people can already know basically everything important about the project.
Describe the solution you'd like Change our readme structure to something more descriptive.
What is the added value? A more descriptive readme would help people get a better sense of the project at first glance.
Give us examples of the outcome
Maybe something following this structure:
Title Badges Description Features How to run the tests AwsSM getting started Link to other Backend docs Link to contributing
And we can have specific readmes for the other backends. I prefer to have a getting started with the most popular backend (AWS Secret Manager) in the readme, so with the readme itself people can already know basically everything important about the project.