Closed thisismydesign closed 4 years ago
+1 for using YAML instead of JSON. This could replace the table altogether. One note on the format is that the comments should clarify which option is mandatory/optional.
On second thought, since AFAICS there's merely one mandatory option, it's sufficient to highlight this somewhere outside of the context(or right above the corresponding option).
## Configuration
Each config is optional except for the product's title if exists.
YML ...
Resolved by #106.
The current table approach in the readme is quite overwhelming, and a bit redundant with the example above and hard to follow.
One thing we could do is use the
yml
format which allows for comments and more structure. That way we could include the docs and examples in the config file itself, similar to when you'd init a new project in some frameworks.@gomorizsolt @nkapolcs your input in welcome, can you think of other ways?