Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme could use improvements #48

Open
julie777 opened this issue Sep 24, 2021 · 2 comments
Open

Readme could use improvements #48

julie777 opened this issue Sep 24, 2021 · 2 comments

Comments

@julie777
Copy link

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.

@rstoenescu
Copy link
Member

It does say in bold at the top: “For the premium (and recommended) experience with Quasar, including the ability to build Mobile & Electron apps and efortless upgrades to new Quasar versions, you should instead use Quasar CLI

@vllcrz
Copy link

vllcrz commented May 10, 2022

It does say in bold at the top: “For the premium (and recommended) experience with Quasar, including the ability to build Mobile & Electron apps and efortless upgrades to new Quasar versions, you should instead use Quasar CLI

That does not describe in any way what the vue-cli-plugin-quasar package does or how it is meant to be used or configured. If I use Vue CLI and not Quasar CLI, what is this package for? Are there any configuration options? Also:

  • Which versions of this plugin are compatible with which versions of Vue CLI?
  • Which versions of this plugin are compatible with which versions of Vue?
  • Which versions of this plugin are compatible with which versions of Quasar?
  • Which versions of Quasar are compatible with which versions of Vue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants