Roadmap

[RichardLitt]

Roadmap

• Example Readmes
• Integrate CPAN feedback from @noffle learn from CPAN perl hackers #3
• Generator with yo as an implicit dependency. Create a Standard Readme generator #6
• Try to merge some standard- and common-readme ideas into one readme. be common-readme compatible #10
  • Make it less js-specific make it less js specific? #8
• Linter Create a Standard Readme linter #5
• Use on specific IPFS Readmes, get feedback from Protocol Lab developers
• Usage tests: Get a bunch of people to use it in their projects and gather feedback on whether it's useful and how we can improve it to match real people's need.
• Press Release
  • Medium Article
  • Post on HackerNews
  • Post on Reddit
  • IPFS Newsletter (again)
  • npm weekly (they might pick this up -- they often take community modules)
• Create badge. Specify as optional.
• Plugins
  • Build Atom plugin
  • Build Sublime plugin

[RichardLitt]

Title can now be validated using wooorm/remark and RichardLitt/remark-title.

[RichardLitt]

Note: Keep up to date and check with ipfs-inactive/project-repos#1.

[mafintosh]

After looking through my/other people's repos i think

A clear description in the GitHub description field, of over 150 characters.

Should be changed to

A clear description in the GitHub description field

[RichardLitt]

Changed. Working on a module for getting and setting that.

[RichardLitt]

Created remark-lint-appropriate-heading to make sure that the heading matches the dir name of the Readme. Works for top level readmes.

[RichardLitt]

I am going to track the Linter and the Generator in their appropriate issues. Since the spec is done, and those are the main things to do, I am going to close this issue for now. Reopen to discuss.

[RichardLitt]

I have edited the Roadmap in the first comment. Let's go!