Skip to content

Better README.md聽#8

Description

@wojciechczerniak

Description

Readme will be published to NPM, we should move technical details to documentation and rework the readme.md for an upcoming release. We can use the table of content from HoT:

  • Logo
  • Description and badges
  • Screenshot? 馃
  • Installation
  • Usage
  • Features
  • Documentation
  • Support and contribution
  • Browsers compatibility
  • License
  • Credits

Work in progress is here: https://docs.google.com/document/d/1YXckeIczaB24QrsFGdNR5JxeXJjuKxdRUX5Qh2rjg8o/edit

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

ChoreDevops and scripting. Tasks that are not changing the productVerifiedVerified by Handsoncode

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions