Dredd's README could be updated. Dredd now supports many languages, many OS, many API description documents. The current README suddenly seems overly complicated and it doesn't really push the user to try out the tool.
Aim of this issue is to come up with a facelift or revamp to the README. The scope of the story is just the README.md file, not homepage of Dredd's docs. The homepage is technically a different document (docs/index.md), although largely similar. It can have different purposes (like index of pages in docs) and little use case nuances. We would update the index page in the next step. Let's focus on README.md exclusively now, with all its limitations (what GitHub supports in their Markdown etc.).
Preliminary ideas
Use tables for better layout of things
Animated gif to showcase what Dredd does
Include list of talks about Dredd (YouTube videos, decks)?
Emphasize people should go to docs for further info
List all communication channels (Gitter, all our Slacks, email, create issue link...)
Currently you can't google out Dredd with http api test tool, rest api testing, or anything like that - can we identify some keywords and make sure they're used within the README?
honzajavorek
commented
5 years ago
Dredd's README could be updated. Dredd now supports many languages, many OS, many API description documents. The current README suddenly seems overly complicated and it doesn't really push the user to try out the tool.
Aim of this issue is to come up with a facelift or revamp to the README. The scope of the story is just the README.md file, not homepage of Dredd's docs. The homepage is technically a different document (
docs/index.md), although largely similar. It can have different purposes (like index of pages in docs) and little use case nuances. We would update the index page in the next step. Let's focus on README.md exclusively now, with all its limitations (what GitHub supports in their Markdown etc.).Preliminary ideas
http api test tool,rest api testing, or anything like that - can we identify some keywords and make sure they're used within the README?Inspiration, resources