Skip to content

Great README examples (documentation, markdown) #11

@coolaj86

Description

@coolaj86

What should a README be?

Projects should have READMEs that have

  • Easy to understand the purpose
  • At-a-glance visual usage / demo
  • Actual demo
  • Easy deploy instructions

Great READMEs

Master Markdown

(honestly, it's easy)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions