Browse Source

feat(setup) .github and README

Signed-off-by: Daniel Thompson-Yvetot <denjell@quasar.dev>
Daniel Thompson-Yvetot 6 years ago
parent
commit
7bd6e0ddb1

+ 2 - 4
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: Bug report
-about: Create a report to help us improve Quasar
+about: Create a report to help us improve Proton
 title: ''
 labels: bug
 assignees: ''
@@ -10,9 +10,6 @@ assignees: ''
 **Describe the bug**
 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**
 Steps to reproduce the behavior:
 1. Go to '...'
@@ -35,6 +32,7 @@ Browsers:
 iOS:
 Android:
 Electron:
+Proton Binding:
 
 **Additional context**
 Add any other context about the problem here.

+ 1 - 1
.github/ISSUE_TEMPLATE/docs-report.md

@@ -1,6 +1,6 @@
 ---
 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]"
 labels: docs
 assignees: ''

+ 1 - 1
.github/ISSUE_TEMPLATE/feature_request.md

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

+ 27 - 4
README.md

@@ -1,7 +1,12 @@
 # quasar-proton [WIP]
 ## 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/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">
 fast binaries for all major desktop platforms. In Quasar's 
@@ -39,9 +44,6 @@ you through the process.
 | FLOSS | Yes | No |
 | Multithreading | Yes | No |
 | Bytecode Delivery | Yes | No |
-| GPU Support | Yes | No |
-| Geolocation | Yes | No |
-| WebAPI | Yes | No |
 | Multiple Windows | Yes | Yes |
 | Can Render PDF | Yes | No |
 | 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
 - [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
 Code: (c) 2019 - Daniel Thompson-Yvetot, Razvan Stoenescu, Lucas Nogueira.
 MIT and where applicable Apache

+ 9 - 8
SECURITY.md

@@ -4,10 +4,8 @@
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 5.1.x   | :white_check_mark: |
-| 5.0.x   | :x:                |
-| 4.0.x   | :white_check_mark: |
-| < 4.0   | :x:                |
+| > 1.0   | :white_check_mark: |
+| < 1.0   | :x:                |
 
 ## 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 DON’T create a pull-request, DON’T
 file an issue on GitHub, DON’T mention it on Discord and DON’T 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
-if appropriate. 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.
+if appropriate. 
+
+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
 
@@ -26,7 +27,7 @@ You can apply to book the Quasar team’s security experts to perform a Security
 for your project. Contact us to find out more about how to acquire, validate and publish
 an official timestamped and version-locked audit badge.
 
-security@quasar.dev
+`security@quasar.dev`
 
 ## Security Documentation