Skip to content

Commit

Permalink
docs: revamp README structure. Improve readability of parameter list
Browse files Browse the repository at this point in the history
Experience has shown that some people like the illusion of saving time
by copying and pasting around stuff around without bothering to read
more in-depth documentation first, for a variety of good (and bad)
reasons. To please those impatient people, let's move the usage examples
to a more prominent place.

In addition, GitHub renders tables in a way that reading the input
parameters description is uncomfortable. Let's flatten that table to a
structure of paragraphs and titles for better readability.
  • Loading branch information
AlexTMjugador committed Sep 6, 2022
1 parent e2f5e71 commit b78eb81
Show file tree
Hide file tree
Showing 2 changed files with 471 additions and 71 deletions.

0 comments on commit b78eb81

Please sign in to comment.