feat(setup) .github and README

Signed-off-by: Daniel Thompson-Yvetot <denjell@quasar.dev>
This commit is contained in:
Daniel Thompson-Yvetot 2019-07-13 21:55:25 +02:00
parent b3e582684a
commit 7bd6e0ddb1
No known key found for this signature in database
GPG Key ID: A88F800A19E176E6
5 changed files with 40 additions and 18 deletions

View File

@ -1,6 +1,6 @@
--- ---
name: Bug report name: Bug report
about: Create a report to help us improve Quasar about: Create a report to help us improve Proton
title: '' title: ''
labels: bug labels: bug
assignees: '' assignees: ''
@ -10,9 +10,6 @@ assignees: ''
**Describe the bug** **Describe the bug**
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
**Codepen/jsFiddle/Codesandbox (required)**
Fork a Codepen (https://codepen.quasar.dev) or a jsFiddle (https://jsfiddle.quasar.dev) or a Codesandbox (https://codesandbox.quasar.dev) and hit save then copy-paste link here.
**To Reproduce** **To Reproduce**
Steps to reproduce the behavior: Steps to reproduce the behavior:
1. Go to '...' 1. Go to '...'
@ -35,6 +32,7 @@ Browsers:
iOS: iOS:
Android: Android:
Electron: Electron:
Proton Binding:
**Additional context** **Additional context**
Add any other context about the problem here. Add any other context about the problem here.

View File

@ -1,6 +1,6 @@
--- ---
name: Docs report name: Docs report
about: Create a report to help us improve Quasar docs about: Create a report to help us improve Proton docs
title: "[docs]" title: "[docs]"
labels: docs labels: docs
assignees: '' assignees: ''

View File

@ -1,6 +1,6 @@
--- ---
name: Feature request name: Feature request
about: Suggest an idea for Quasar about: Suggest an idea for Proton
title: '' title: ''
labels: feature request labels: feature request
assignees: '' assignees: ''

View File

@ -1,7 +1,12 @@
# quasar-proton [WIP] # quasar-proton [WIP]
## A fresh take on creating cross-platform apps. ## A fresh take on creating cross-platform apps.
[![official icon](https://img.shields.io/badge/Quasar%201.0-Official-blue.svg)](https://quasar.dev) [![official icon](https://img.shields.io/badge/Quasar%201.0-Official-blue.svg)](https://quasar.dev)
[![official icon](https://img.shields.io/badge/Status-Internal%20Review-yellow.svg)](https://github.com/quasarframework/quasar/tree/proton) [![status](https://img.shields.io/badge/Status-Internal%20Review-yellow.svg)](https://github.com/quasarframework/quasar/tree/proton)
[![version](https://img.shields.io/badge/Version-unreleased-yellow.svg)](https://github.com/quasarframework/quasar/tree/proton)
[![Join the chat at https://chat.quasar.dev](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://chat.quasar.dev)
<a href="https://forum.quasar.dev" target="_blank"><img src="https://img.shields.io/badge/community-forum-brightgreen.svg"></a>
[![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)
**Proton** brings a mode to build Quasar Apps that creates tiny, blazing <img align="right" src="https://cdn.quasar.dev/logo/proton/proton-logo-240x240.png"> **Proton** brings a mode to build Quasar Apps that creates tiny, blazing <img align="right" src="https://cdn.quasar.dev/logo/proton/proton-logo-240x240.png">
fast binaries for all major desktop platforms. In Quasar's fast binaries for all major desktop platforms. In Quasar's
@ -39,9 +44,6 @@ you through the process.
| FLOSS | Yes | No | | FLOSS | Yes | No |
| Multithreading | Yes | No | | Multithreading | Yes | No |
| Bytecode Delivery | Yes | No | | Bytecode Delivery | Yes | No |
| GPU Support | Yes | No |
| Geolocation | Yes | No |
| WebAPI | Yes | No |
| Multiple Windows | Yes | Yes | | Multiple Windows | Yes | Yes |
| Can Render PDF | Yes | No | | Can Render PDF | Yes | No |
| Updater | Yes | Yes | | Updater | Yes | Yes |
@ -65,6 +67,27 @@ honoured to carry the torch further. Of special note:
- [zserge](https://github.com/zserge) for the original webview approach - [zserge](https://github.com/zserge) for the original webview approach
- [Boscop](https://github.com/Boscop) for the Rust Bindings - [Boscop](https://github.com/Boscop) for the Rust Bindings
## Documentation
Head over to the Quasar Framework official website: [https://quasar.dev](https://quasar.dev)
## Stay in Touch
For latest releases and announcements, follow on Twitter: [@quasarframework](https://twitter.com/quasarframework)
## Chat Support
Get realtime help at the official community Discord server: [https://chat.quasar.dev](https://chat.quasar.dev)
## Community Forum
Ask complicated questions at the official community forum: [https://forum.quasar.dev](https://forum.quasar.dev)
## Contributing
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request. If you have a Quasar-related project/component/tool, add it with a pull request to [this curated list](https://github.com/quasarframework/quasar-awesome)!
Thank you to all the people who already <a href="https://github.com/quasarframework/quasar/graphs/contributors">contributed to Proton</a>!
## Semver
Quasar is following [Semantic Versioning 2.0](https://semver.org/).
## Licenses ## Licenses
Code: (c) 2019 - Daniel Thompson-Yvetot, Razvan Stoenescu, Lucas Nogueira. Code: (c) 2019 - Daniel Thompson-Yvetot, Razvan Stoenescu, Lucas Nogueira.
MIT and where applicable Apache MIT and where applicable Apache

View File

@ -4,10 +4,8 @@
| Version | Supported | | Version | Supported |
| ------- | ------------------ | | ------- | ------------------ |
| 5.1.x | :white_check_mark: | | > 1.0 | :white_check_mark: |
| 5.0.x | :x: | | < 1.0 | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
## Reporting a Vulnerability ## Reporting a Vulnerability
@ -15,10 +13,13 @@ If you have found a potential security threat, vulnerability or exploit in Quasa
or one of its upstream dependencies, please DONT create a pull-request, DONT or one of its upstream dependencies, please DONT create a pull-request, DONT
file an issue on GitHub, DONT mention it on Discord and DONT create a forum thread. file an issue on GitHub, DONT mention it on Discord and DONT create a forum thread.
DO reach out to the team by sending an email to security@quasar.dev - we DO reach out to the team by sending an email to **security@quasar.dev** - we
will investigate and work with you to triage this issue and help you to report it will investigate and work with you to triage this issue and help you to report it
if appropriate. At the current time we do not have the financial ability to reward if appropriate.
bounties, but in extreme cases will at our discretion consider a reward.
If you like, you may use PGP to encrypt your messages, as the public key has been published at the pgp.mit.edu keyserver.
At the current time we do not have the financial ability to reward bounties, but in extreme cases will at our discretion consider a reward.
## Security Audit ## Security Audit
@ -26,7 +27,7 @@ You can apply to book the Quasar teams security experts to perform a Security
for your project. Contact us to find out more about how to acquire, validate and publish for your project. Contact us to find out more about how to acquire, validate and publish
an official timestamped and version-locked audit badge. an official timestamped and version-locked audit badge.
security@quasar.dev `security@quasar.dev`
## Security Documentation ## Security Documentation