Skip to content

Commit b6dd3c7

Browse files
committed
chore: Update all READMEs quasarframework#4269
1 parent 40e43f2 commit b6dd3c7

File tree

7 files changed

+189
-114
lines changed

7 files changed

+189
-114
lines changed

README.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
<img src="https://img.shields.io/npm/v/quasar.svg?label=quasar"> <img src="https://img.shields.io/npm/v/%40quasar/app.svg?label=@quasar/app"> <img src="https://img.shields.io/npm/v/%40quasar/cli.svg?label=@quasar/cli"> <img src="https://img.shields.io/npm/v/%40quasar/extras.svg?label=@quasar/extras">
88

9-
[![Join the chat at https://discord.gg/5TDhbDg](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/5TDhbDg)
9+
[![Join the chat at https://chat.quasar.dev](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://chat.quasar.dev)
1010
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
1111
[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
1212

@@ -141,20 +141,6 @@ Ask questions at the official community forum: [https://forum.quasar.dev](https:
141141

142142
I'm excited if you want to contribute to Quasar under any form (report bugs, write a plugin, fix an issue, write a new feature).
143143

144-
### Issue Reporting Guidelines
145-
146-
**Please use the appropriate GitHub repo to report issues. See "Related Components" above.** For example, a bug related to CLI should be reported to the CLI repo, one related to build issues to Quasar Framework Templates repo and so on.
147-
148-
- The issue list of the repository is **exclusively** for bug reports and feature requests. For anything else please use the [Community Forum](https://forum.quasar.dev).
149-
150-
- Try to search for your issue, it may have already been fixed in the development branch or it may have a resolution.
151-
152-
- Check if the issue is reproducible with the latest stable version of Quasar. If you are using a pre-release, please indicate the specific version you are using.
153-
154-
- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.
155-
156-
- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.
157-
158144
## Semver
159145
Quasar is following [Semantic Versioning 2.0](https://semver.org/).
160146

app/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
![Quasar Framework logo](https://cdn.quasar.dev/logo/svg/quasar-logo-full-inline.svg)
2+
3+
# Quasar Framework App CLI (Local)
4+
5+
> Build responsive Single Page Apps, **SSR Apps**, PWAs, Hybrid Mobile Apps and Electron Apps, all using the same codebase!, powered with Vue.
6+
7+
<img src="https://img.shields.io/npm/v/%40quasar/app.svg?label=@quasar/app">
8+
9+
[![Join the chat at https://chat.quasar.dev](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://chat.quasar.dev)
10+
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
11+
[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
12+
13+
Please submit a PR to https://github.com/quasarframework/quasar-awesome with your website/app/Quasar tutorial/video etc. Thank you!
14+
15+
## Supporting Quasar
16+
Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/rstoenescu/quasar-framework/blob/dev/backers.md). If you'd like to join them, check out [Quasar Framework's Patreon campaign](https://www.patreon.com/quasarframework).
17+
18+
## Documentation
19+
20+
Head on to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)
21+
22+
## Stay in Touch
23+
24+
For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)
25+
26+
## Chat Support
27+
28+
Ask questions at the official community Discord server: [https://chat.quasar.dev](https://chat.quasar.dev)
29+
30+
## Community Forum
31+
32+
Ask questions at the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)
33+
34+
## Contributing
35+
36+
I'm excited if you want to contribute to Quasar under any form (report bugs, write a plugin, fix an issue, write a new feature).
37+
38+
## Semver
39+
Quasar is following [Semantic Versioning 2.0](https://semver.org/).
40+
41+
## License
42+
43+
Copyright (c) 2015-present Razvan Stoenescu
44+
45+
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

babel-preset-app/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
![Quasar Framework logo](https://cdn.quasar.dev/logo/svg/quasar-logo-full-inline.svg)
2+
3+
# Quasar Framework CLI Babel Preset
4+
5+
> Build responsive Single Page Apps, **SSR Apps**, PWAs, Hybrid Mobile Apps and Electron Apps, all using the same codebase!, powered with Vue.
6+
>
7+
> **DO NOT manually install this package. This package is supplied by `@quasar/app` and should not be used outside of it.**
8+
9+
<img src="https://img.shields.io/npm/v/%40quasar/babel-preset-app.svg?label=@quasar/babel-preset-app">
10+
11+
[![Join the chat at https://chat.quasar.dev](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://chat.quasar.dev)
12+
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
13+
[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
14+
15+
## Supporting Quasar
16+
Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/rstoenescu/quasar-framework/blob/dev/backers.md). If you'd like to join them, check out [Quasar Framework's Patreon campaign](https://www.patreon.com/quasarframework).
17+
18+
## Documentation
19+
20+
Head on to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)
21+
22+
## Stay in Touch
23+
24+
For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)
25+
26+
## Chat Support
27+
28+
Ask questions at the official community Discord server: [https://chat.quasar.dev](https://chat.quasar.dev)
29+
30+
## Community Forum
31+
32+
Ask questions at the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)
33+
34+
## Contributing
35+
36+
I'm excited if you want to contribute to Quasar under any form (report bugs, write a plugin, fix an issue, write a new feature).
37+
38+
## Semver
39+
Quasar is following [Semantic Versioning 2.0](https://semver.org/).
40+
41+
## License
42+
43+
Copyright (c) 2015-present Razvan Stoenescu
44+
45+
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

cli/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
![Quasar Framework logo](https://cdn.quasar.dev/logo/svg/quasar-logo-full-inline.svg)
2+
3+
# Quasar Framework CLI (Global)
4+
5+
> Build responsive Single Page Apps, **SSR Apps**, PWAs, Hybrid Mobile Apps and Electron Apps, all using the same codebase!, powered with Vue.
6+
7+
<img src="https://img.shields.io/npm/v/%40quasar/cli.svg?label=@quasar/cli">
8+
9+
[![Join the chat at https://chat.quasar.dev](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://chat.quasar.dev)
10+
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
11+
[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
12+
13+
Please submit a PR to https://github.com/quasarframework/quasar-awesome with your website/app/Quasar tutorial/video etc. Thank you!
14+
15+
## Supporting Quasar
16+
Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/rstoenescu/quasar-framework/blob/dev/backers.md). If you'd like to join them, check out [Quasar Framework's Patreon campaign](https://www.patreon.com/quasarframework).
17+
18+
## Documentation
19+
20+
Head on to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)
21+
22+
## Stay in Touch
23+
24+
For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)
25+
26+
## Chat Support
27+
28+
Ask questions at the official community Discord server: [https://chat.quasar.dev](https://chat.quasar.dev)
29+
30+
## Community Forum
31+
32+
Ask questions at the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)
33+
34+
## Contributing
35+
36+
I'm excited if you want to contribute to Quasar under any form (report bugs, write a plugin, fix an issue, write a new feature).
37+
38+
## Semver
39+
Quasar is following [Semantic Versioning 2.0](https://semver.org/).
40+
41+
## License
42+
43+
Copyright (c) 2015-present Razvan Stoenescu
44+
45+
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

docs/README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,35 @@
1-
# Quasar App
1+
![Quasar Framework logo](https://cdn.quasar.dev/logo/svg/quasar-logo-full-inline.svg)
22

3-
> WIP
3+
## Quasar Framework Documentation
4+
5+
> Build responsive Single Page Apps, **SSR Apps**, PWAs, Hybrid Mobile Apps and Electron Apps, all using the same codebase!, powered with Vue.
6+
7+
[![Join the chat at https://discord.gg/5TDhbDg](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/5TDhbDg)
8+
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
9+
[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
10+
11+
## Supporting Quasar
12+
Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/rstoenescu/quasar-framework/blob/dev/backers.md). If you'd like to join them, check out [Quasar Framework's Patreon campaign](https://www.patreon.com/quasarframework).
13+
14+
## Documentation
15+
16+
Head on to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)
17+
18+
## Stay in Touch
19+
20+
For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)
21+
22+
## Chat Support
23+
24+
Ask questions at the official community Discord server: [https://chat.quasar.dev](https://chat.quasar.dev)
25+
26+
## Community Forum
27+
28+
Head on to the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)
29+
30+
## Semver
31+
Using [semver 2.0](http://semver.org/) notation for 'quasar-extras' package.
32+
33+
## License
34+
35+
All assets included in this repository are exclusive property of their respective owners. Quasar does not take any credit in packages included here.

extras/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
![Quasar Framework logo](https://cdn.rawgit.com/quasarframework/quasar-art/863c14bd/dist/svg/quasar-logo-full-inline.svg)
1+
![Quasar Framework logo](https://cdn.quasar.dev/logo/svg/quasar-logo-full-inline.svg)
22

3-
## Quasar Framework
3+
## Quasar Framework Extras Package
44

55
> Build responsive Single Page Apps, **SSR Apps**, PWAs, Hybrid Mobile Apps and Electron Apps, all using the same codebase!, powered with Vue.
66
7-
# Quasar Framework Extras
7+
<img src="https://img.shields.io/npm/v/%40quasar/extras.svg?label=@quasar/extras">
88

9-
<a href="https://badge.fury.io/js/%40quasar%2Fextras" target="_blank"><img src="https://badge.fury.io/js/%40quasar%2Fextras.svg"></a>
10-
[![Join the chat at https://discord.gg/5TDhbDg](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/5TDhbDg)
9+
[![Join the chat at https://chat.quasar.dev](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://chat.quasar.dev)
1110
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
11+
[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
12+
13+
## Contents
1214

1315
| Package | quasar.conf.js extras name | Version | Description |
1416
| --- | --- | --- | --- |
@@ -35,6 +37,10 @@ Head on to the Quasar Framework official website: [https://quasar.dev](https://q
3537

3638
For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)
3739

40+
## Chat Support
41+
42+
Ask questions at the official community Discord server: [https://chat.quasar.dev](https://chat.quasar.dev)
43+
3844
## Community Forum
3945

4046
Head on to the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)

ui/README.md

Lines changed: 8 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,20 @@
1-
![Quasar Framework logo](https://cdn.rawgit.com/quasarframework/quasar-art/863c14bd/dist/svg/quasar-logo-full-inline.svg)
1+
![Quasar Framework logo](https://cdn.quasar.dev/logo/svg/quasar-logo-full-inline.svg)
22

3-
# Quasar Framework
3+
# Quasar Framework UI Package
44

55
> Build responsive Single Page Apps, **SSR Apps**, PWAs, Hybrid Mobile Apps and Electron Apps, all using the same codebase!, powered with Vue.
66
7-
<a href="https://badge.fury.io/js/quasar-framework" target="_blank"><img src="https://badge.fury.io/js/quasar-framework.svg"></a>
8-
[![Join the chat at https://discord.gg/5TDhbDg](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/5TDhbDg)
7+
<img src="https://img.shields.io/npm/v/quasar.svg?label=quasar">
8+
9+
[![Join the chat at https://chat.quasar.dev](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://chat.quasar.dev)
910
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
11+
[![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
1012

1113
Please submit a PR to https://github.com/quasarframework/quasar-awesome with your website/app/Quasar tutorial/video etc. Thank you!
1214

1315
## Supporting Quasar
1416
Quasar Framework is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/rstoenescu/quasar-framework/blob/dev/backers.md). If you'd like to join them, check out [Quasar Framework's Patreon campaign](https://www.patreon.com/quasarframework).
1517

16-
### Proudly sponsored by:
17-
18-
<table>
19-
<tbody>
20-
<tr>
21-
<td align="center" valign="middle">
22-
<a href="https://truelogic.com" target="_blank">
23-
<img width="300px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/41e5204e/truelogic.png">
24-
</a>
25-
</td>
26-
<td align="center" valign="middle">
27-
<a href="https://www.tayloredtechnology.net" target="_blank">
28-
<img width="300px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/63939d4e/taylored-technology-big.jpeg">
29-
</a>
30-
</td>
31-
</tr>
32-
<tr></tr>
33-
<tr>
34-
<td align="center" valign="middle">
35-
<a href="http://campuscloudservices.com" target="_blank">
36-
<img width="222px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/63939d4e/campus-cloud-services.png">
37-
</a>
38-
</td>
39-
<td align="center" valign="middle">
40-
<a href="https://www.jugglestreet.com" target="_blank">
41-
<img width="222px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/63939d4e/juggle-street.png">
42-
</a>
43-
</td>
44-
</tr>
45-
<tr></tr>
46-
<tr>
47-
<td align="center" valign="middle">
48-
<a href="http://comcomservices.com" target="_blank">
49-
<img width="222px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/63939d4e/com-com-services.png">
50-
</a>
51-
</td>
52-
<td align="center" valign="middle">
53-
<a href="http://www.kalisio.com" target="_blank">
54-
<img width="222px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/63939d4e/kalisio.png">
55-
</a>
56-
</td>
57-
</tr>
58-
<tr></tr>
59-
<tr>
60-
<td align="center" valign="middle">
61-
<a href="http://platformpurple.com" target="_blank">
62-
<img width="222px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/63939d4e/platform-purple.png">
63-
</a>
64-
</td>
65-
<td align="center" valign="middle">
66-
<a href="http://www.bgasoft.com" target="_blank">
67-
<img width="222px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/63939d4e/bgasoft.png">
68-
</a>
69-
</td>
70-
</tr>
71-
</tbody>
72-
</table>
73-
74-
### Partners
75-
76-
<table>
77-
<tbody>
78-
<tr>
79-
<td align="center" valign="middle">
80-
<a href="https://utopian.io" target="_blank">
81-
<img width="222px" src="https://cdn.rawgit.com/rstoenescu/quasar-backers-logo/41e5204e/utopian.png">
82-
</a>
83-
</td>
84-
</tr>
85-
</tbody>
86-
</table>
87-
8818
## Documentation
8919

9020
Head on to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)
@@ -105,25 +35,11 @@ Ask questions at the official community forum: [https://forum.quasar.dev](https:
10535

10636
I'm excited if you want to contribute to Quasar under any form (report bugs, write a plugin, fix an issue, write a new feature).
10737

108-
### Issue Reporting Guidelines
109-
110-
**Please use the appropriate GitHub repo to report issues. See "Related Components" above.** For example, a bug related to CLI should be reported to the CLI repo, one related to build issues to Quasar Framework Templates repo and so on.
111-
112-
- The issue list of the repository is **exclusively** for bug reports and feature requests. For anything else please use the [Community Forum](https://forum.quasar.dev).
113-
114-
- Try to search for your issue, it may have already been fixed in the development branch or it may have a resolution.
115-
116-
- Check if the issue is reproducible with the latest stable version of Quasar. If you are using a pre-release, please indicate the specific version you are using.
117-
118-
- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled "need repro" receives no further input from the issue author for more than 5 days, it will be closed.
119-
120-
- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.
121-
12238
## Semver
123-
Until Quasar reaches a 1.0 release (soon), breaking changes will be released with a new minor version. For example 0.8.1, and 0.8.4 will have the same API, but 0.9.0 will have breaking changes.
39+
Quasar is following [Semantic Versioning 2.0](https://semver.org/).
12440

12541
## License
12642

127-
Copyright (c) 2016-present Razvan Stoenescu
43+
Copyright (c) 2015-present Razvan Stoenescu
12844

12945
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

0 commit comments

Comments
 (0)