quasarframework
Readme could use improvements
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.
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”
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?
