Skip to content

Readme could use improvements #48

Open
@julie777

Description

@julie777

This is a general comment I have about most project readme files which are show below the code in a github project.

The first thing is usually usage or install.
Please start with a description of the project/repo, what it does and why someone would use it.

Vue-cli-plugin-quasar is a good example. If I just look at the readme I won't immediately realize that I don't need it because I use the Quasar cli.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions