Readme driven

readme driven documentation

readme maturity

readme coverage

last year i tried readme driven development and it simply works

here a brief readme driven template off the cuff

# readme

<this> app was created to solve <this> problem

it is simple to create a gif showing what your app done and this can save people a lot of time
in understanding what it does and if they need it or not

![](gif-demo.gif)

## installation

code block
sudo apt install <this>

## configuration

* <this file> is where you configure <this feature>
    * here is how you configure  
* <this file> is where you configure <this feature>
    * here is how you configure it

## usage

### command line interface 

(almost every app should have an cli - a cli or web api is how you automate, YOU CANNOT AUTOMATE A GUI so please spend more time on your cli or api)

code block
<this command> 

if you have a gui and design it intuitively it requries little documentation but should include
 contextual links to online documentation using [mkdocs](https://www.mkdocs.org/) or [readthedocs](https://readthedocs.org/)

### api usage

you can create a webpage to demo your api 

the best example i've seen is [monday](https://monday.com/developers/v2)

## features

Comments