thomaspoignant / api-scenario

API-scenario is a command-line tool that allows you to execute easily a scenario to test your APIs.

https://github.com/thomaspoignant/api-scenario#api-scenario

The Unlicense

16 stars 3 forks source link

Split the doc and use mkdocs #68

Open thomaspoignant opened 4 years ago

thomaspoignant commented 4 years ago

Motivation

Currently, the readme is a bit hard to read because there is too much information on a single page.

Requirements

I think we should split the readme into multiple files and create a mkdocs site to display it correctly. I think we should use the material theme which is really great. We could deploy this site as GitHub Pages.

thomaspoignant commented 4 years ago

@aftouh what do you think about that?