Update to README, added issue templates, moved banner to resources, updated gitignore for .vscode
This commit is contained in:
parent
c2a2551824
commit
3556136515
5 changed files with 79 additions and 19 deletions
39
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
39
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
---
|
||||||
|
name: Bug Report
|
||||||
|
about: If you encounter an issue whilst using our app, please use this template to help improve the app.
|
||||||
|
title: "[BUG] "
|
||||||
|
labels: bug
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Environment Information**
|
||||||
|
- OS *(e.g. Linux/Mac/Windows)*:
|
||||||
|
- Application Version *(e.g. 2.5.0)*:
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
||||||
|
|
||||||
|
**Have you followed the troubleshooting guide and checked for any outstanding/pinned issues that can help?**
|
||||||
|
*Troubleshooting guide can be found [here](https://github.com/Apple-Music-Electron/Apple-Music-Electron/wiki/Troubleshooting).*
|
||||||
|
Yes/No
|
||||||
|
|
||||||
|
**Log File**
|
||||||
|
Follow [this](https://github.com/Apple-Music-Electron/Apple-Music-Electron/wiki/FAQs#2-how-to-find-the-log-file) to find your log file.
|
||||||
|
Attach your log file to the post but make sure to remove any LastFM keys that are in the file.
|
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: "[Enhancement]"
|
||||||
|
labels: enhancement
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Is your feature request related to a problem? Please describe.**
|
||||||
|
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||||
|
|
||||||
|
**Describe the solution you'd like**
|
||||||
|
A clear and concise description of what you want to happen.
|
||||||
|
|
||||||
|
**Describe alternatives you've considered**
|
||||||
|
A clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context or screenshots about the feature request here.
|
14
.gitignore
vendored
14
.gitignore
vendored
|
@ -1,10 +1,16 @@
|
||||||
|
# NodeJS
|
||||||
node_modules
|
node_modules
|
||||||
|
|
||||||
|
# Building
|
||||||
dist
|
dist
|
||||||
.idea
|
*.lock
|
||||||
yarn.lock
|
yarn*
|
||||||
package-lock.json
|
package-lock.json
|
||||||
.DS_Store
|
|
||||||
yarn-error.log
|
|
||||||
.yarnclean
|
.yarnclean
|
||||||
|
|
||||||
|
# Misc
|
||||||
|
.idea
|
||||||
|
.vscode
|
||||||
auth.json
|
auth.json
|
||||||
musickit.js
|
musickit.js
|
||||||
|
.DS_Store
|
21
README.md
21
README.md
|
@ -1,18 +1,15 @@
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://raw.githubusercontent.com/ciderapp/Cider/main/logobannercider.png" width="80%" height="40%" alt="Banner"><br><br>
|
<img src="./resources/banner.png" width="80%" height="40%" alt="Banner"><br><br>
|
||||||
<img src="https://img.shields.io/github/release/ciderapp/Cider.svg?style=flat" alt="GitHub Releases"/>
|
<img src="https://img.shields.io/github/release/ciderapp/Cider.svg?style=flat&label=Latest%20Release" alt="GitHub Releases"/>
|
||||||
<img src="https://img.shields.io/github/stars/ciderapp/Cider" alt="GitHub Stars"/>
|
<img src="https://img.shields.io/github/stars/ciderapp/Cider?label=Stars" alt="GitHub Stars"/>
|
||||||
<img src="https://img.shields.io/github/forks/ciderapp/Cider" alt="GitHub Forks"/>
|
<img src="https://img.shields.io/github/forks/ciderapp/Cider?label=Forks" alt="GitHub Forks"/>
|
||||||
<img src="https://img.shields.io/github/downloads/ciderapp/Cider/total.svg?color=23B14D" alt="GitHub Downloads"/>
|
<img src="https://img.shields.io/github/downloads/ciderapp/Cider/total.svg?color=23B14D&label=Downloads" alt="GitHub Downloads"/>
|
||||||
<img src="https://badges.depfu.com/badges/121fff86821ca5a2bf9741f80b8f0a68/overview.svg" alt="Depfu Dependencies"/>
|
<br>
|
||||||
<a target="_blank" href="https://ko-fi.com/cryptofyre"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-B48C69" alt="Buy Me A Coffee"/></a>
|
<a target="_blank" href="https://ko-fi.com/cryptofyre"><img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-donate-B48C69" alt="Buy Me A Coffee"/></a>
|
||||||
|
<a target="_blank" href="https://opencollective.com/ciderapp"><img src="https://img.shields.io/opencollective/all/ciderapp?color=%237FADF2&label=Backers%20and%20Sponsors&logo=opencollective" alt="Open Collective"/></a>
|
||||||
<br>
|
<br>
|
||||||
<a target="_blank" href="https://discord.gg/applemusic"><img src="https://img.shields.io/discord/843954443845238864?label=Discord&color=5865F2&logo=discord&logoColor=white&style=flat" alt="Discord"/></a>
|
<a target="_blank" href="https://discord.gg/applemusic"><img src="https://img.shields.io/discord/843954443845238864?label=Discord&color=5865F2&logo=discord&logoColor=white&style=flat" alt="Discord"/></a>
|
||||||
<a target="_blank" href="https://twitter.com/CollectiveCider"><img src="https://img.shields.io/twitter/follow/CollectiveCider?label=Twitter&color=%231DA1F2&logo=twitter&style=flat" alt="Twitter"/></a>
|
<a target="_blank" href="https://twitter.com/CollectiveCider"><img src="https://img.shields.io/twitter/follow/CollectiveCider?label=Twitter&color=%231DA1F2&logo=twitter&style=flat" alt="Twitter"/></a>
|
||||||
|
|
||||||
<a target="_blank" href="https://opencollective.com/ciderapp"><img src="https://img.shields.io/opencollective/all/ciderapp?label=Open Collective Sponseres and Supporters&color=7FADF2&logo=opencollective&style=for-the-badge" alt="Open Collective"/></a>
|
|
||||||
|
|
||||||
|
|
||||||
<a target="_blank" href="https://reddit.com/r/applemusicelectron"><img src="https://custom-icon-badges.herokuapp.com/reddit/subreddit-subscribers/applemusicelectron?label=Reddit&color=FF5700&logo=redditnew" alt="Reddit"/></a>
|
<a target="_blank" href="https://reddit.com/r/applemusicelectron"><img src="https://custom-icon-badges.herokuapp.com/reddit/subreddit-subscribers/applemusicelectron?label=Reddit&color=FF5700&logo=redditnew" alt="Reddit"/></a>
|
||||||
<br><br>
|
<br><br>
|
||||||
<img src="https://github.com/ciderapp/Cider/actions/workflows/build-analyze-win.yml/badge.svg" alt="Windows Build Status"/>
|
<img src="https://github.com/ciderapp/Cider/actions/workflows/build-analyze-win.yml/badge.svg" alt="Windows Build Status"/>
|
||||||
|
@ -57,5 +54,3 @@ for any legal concerns contact me at <a href="mailto:cryptofyre@cryptofyre.org">
|
||||||
<img href="https://www.jetbrains.com/" width="120px" height="125px" src="https://logonoid.com/images/jetbrains-logo.png" alt="JetBrains">
|
<img href="https://www.jetbrains.com/" width="120px" height="125px" src="https://logonoid.com/images/jetbrains-logo.png" alt="JetBrains">
|
||||||
<img href="https://www.macstadium.com/" width="300px" src="https://user-images.githubusercontent.com/33162551/124784795-df5d4c80-df0b-11eb-99a7-dc2b1cfb81bd.png" alt="MacStadium">
|
<img href="https://www.macstadium.com/" width="300px" src="https://user-images.githubusercontent.com/33162551/124784795-df5d4c80-df0b-11eb-99a7-dc2b1cfb81bd.png" alt="MacStadium">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<i><a name="ComingSoon">1</a> - Coming Soon</i>
|
|
||||||
|
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Loading…
Add table
Add a link
Reference in a new issue