Skip to content

Commit

Permalink
Update ReadMe to include statuses (#81)
Browse files Browse the repository at this point in the history
* Update ReadMe to include statuses

- remove desktop installations from bug reports
- fix description txt files

* Increase button size

Co-authored-by: Emma <[email protected]>

* Remove period

Co-authored-by: Emma <[email protected]>
  • Loading branch information
ChunkyProgrammer and MarmadileManteater authored Jan 13, 2023
1 parent 72f2b62 commit 1e1d004
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 32 deletions.
24 changes: 5 additions & 19 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Bug Report
description: Report an issue or unexpected behavior that occurs within the application
title: "[Bug]: "
labels: "bug"
labels: ["bug"]
body:
- type: markdown
attributes:
Expand All @@ -14,7 +14,7 @@ body:
description: Please ensure you've completed all of the following.
options:
- label: I have encountered this bug in the [latest release of FreeTube](https://github.com/FreeTubeApp/FreeTube/releases).
required: true
required: true
- label: I have searched the issue tracker for [open](https://github.com/FreeTubeApp/FreeTube/issues?q=is%3Aopen+is%3Aissue) and [closed](https://github.com/FreeTubeApp/FreeTube/issues?q=is%3Aissue+is%3Aclosed) issues that are similar to the bug report I want to file, without success.
required: true
- label: I have searched the [documentation](https://docs.freetubeapp.io/) for information that matches the description of the bug I want to file, without success.
Expand All @@ -31,7 +31,7 @@ body:
3. Scroll down to '....'
4. See error
validations:
required: true
required: true
- type: textarea
attributes:
label: Expected Behavior
Expand Down Expand Up @@ -80,26 +80,12 @@ body:
label: Installation Method
options:
- .apk
- .AppImage
- AUR
- Chocolatey
- .deb
- .dmg
- .exe
- Flathub
- MPR
- .pacman
- Portable
- PortableApps
- .rpm
- Scoop
- winget
- .zip
- PWA (Progressive Web App)
- other
validations:
required: true
- type: dropdown
attributes:
attributes:
label: Primary API used
description: What is the primary API being used?
multiple: false
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Feature request
description: Suggest an idea for FreeTube which you would like to see in a future release
title: "[Feature Request]: "
labels: "enhancement"
labels: ["enhancement"]
body:
- type: markdown
attributes:
Expand Down Expand Up @@ -34,7 +34,7 @@ body:
- type: textarea
attributes:
label: Alternatives Considered
description: A clear and concise description of any alternative solutions or features you've considered.
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: dropdown
Expand Down
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,37 @@
<p align="center" >
<img src="https://docs.freetubeapp.io/images/logoColor.png" width=500 align="center">
<img src="https://docs.freetubeapp.io/images/logoColor.png" width=500 align="center" alt="FreeTube Logo">
</p>
<h2 align='center'>
An open source YouTube player built with privacy in mind.
</h2>

<p align='center'>
<a href='https://github.com/MarmadileManteater/FreeTubeCordova/actions/workflows/buildCordova.yml'>
<img alt='Build Status' src='https://github.com/MarmadileManteater/FreeTubeCordova/actions/workflows/buildCordova.yml/badge.svg'>
</a>
<a href="https://apt.izzysoft.de/fdroid/index/apk/io.freetubeapp.freetube">
<img alt='izzyondroid version' src="https://img.shields.io/endpoint?url=https://apt.izzysoft.de/fdroid/api/v1/shield/io.freetubeapp.freetube">
</a>
<a href="https://hosted.weblate.org/engage/free-tube/">
<img src="https://hosted.weblate.org/widgets/free-tube/-/svg-badge.svg" alt="Translation status" />
</a>
</p>
<hr>
<p align="center"><a href="#screenshots">Screenshots</a> &bull; <a href="#how-does-it-work">How does it work?</a> &bull; <a href="#features">Features</a> &bull; <a href="#how-to-build-and-test">Building and testing</a> &bull; <a href="#contributing">Contributing</a> &bull; <a href="#localization">Localization</a> &bull; <a href="#contact">Contact</a> &bull; <a href="#upstream-donations">Donate</a> &bull; <a href="#license">License</a></p>
<p align="center"><a href="https://freetubeapp.io/">Website</a> &bull; <a href="https://blog.freetubeapp.io/">Blog</a> &bull; <a href="https://docs.freetubeapp.io/">Documentation</a> &bull; <a href="https://docs.freetubeapp.io/faq/">FAQ</a> &bull; <a href="https://github.com/FreeTubeApp/FreeTube/discussions">Discussions</a></p>
<hr>

FreeTube Cordova is an open source YouTube player built with privacy in mind. Use YouTube without advertisements and prevent Google from tracking you with their cookies and JavaScript.
Available for Android and as a PWA. FreeTube Cordova is a fork of [FreeTube](https://www.github.com/FreeTubeApp).
FreeTube Cordova is currently in Beta. While it should work well for most users, there are still bugs and missing features that need to be addressed.
<p align='center'>
<a href='https://apt.izzysoft.de/fdroid/index/apk/io.freetubeapp.freetube'>
<img height='100' alt='Get it on IzzyOnDroid' src='https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png'>
</a>
</p>

<p align="center"><a href="https://github.com/MarmadileManteater/FreeTubeCordova/releases">Download FreeTubeCordova</a></p>

<hr>
<p align="center"><a href="#screenshots">Screenshots</a> &bull; <a href="#how-does-it-work">How does it work?</a> &bull; <a href="#features">Features</a> &bull; <a href="#how-to-build-and-test">Building and testing</a> &bull; <a href="#contributing">Contributing</a> &bull; <a href="#localization">Localization</a> &bull; <a href="#contact">Contact</a> &bull; <a href="#upstream-donations">Donate</a> &bull; <a href="#license">License</a></p>
<p align="center"><a href="https://freetubeapp.io/">Website</a> &bull; <a href="https://blog.freetubeapp.io/">Blog</a> &bull; <a href="https://docs.freetubeapp.io/">Documentation</a> &bull; <a href="https://docs.freetubeapp.io/faq/">FAQ</a> &bull; <a href="https://github.com/FreeTubeApp/FreeTube/discussions">Discussions</a></p>
<hr>

## How does it work?
Expand Down Expand Up @@ -50,6 +71,11 @@ There is an APK which can be downloaded here:

[https://github.com/MarmadileManteater/FreeTubeCordova/releases](https://github.com/MarmadileManteater/FreeTubeCordova/releases)

### Automated Builds (Nightly / Weekly)
Builds are automatically created from changes to our development branch via [GitHub Actions](https://github.com/MarmadileManteater/FreeTubeCordova/actions/workflows/buildCordova.yml).

The first build with a green check mark is the latest build. You will need to have a GitHub account to download these builds.

## How to build and test

```bash
Expand All @@ -71,11 +97,6 @@ There is an APK which can be downloaded here:
yarn run:cordova android
```

#### Automated Builds (Nightly / Weekly)
Builds are automatically created from changes to our development branch via [GitHub Actions](https://github.com/MarmadileManteater/FreeTubeCordova/actions/workflows/buildCordova.yml).

The first build with a green check mark is the latest build. You will need to have a GitHub account to download these builds.

## Contributing

**NOTICE: MOST CHANGES SHOULD PROBABLY BE MADE TO [UPSTREAM](https://www.github.com/freetubeapp/freetube) UNLESS DIRECTLY RELATED TO CORDOVA CODE OR WORKFLOWS.**
Expand Down
1 change: 1 addition & 0 deletions metadata/en-US/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ No official YouTube APIs are used to obtain data.
Your subscriptions and history are stored locally on your device and are never sent out.

Features:

- Watch videos without ads
- Use YouTube without Google tracking you using cookies and JavaScript
- Organize your subscriptions into Profiles to create a more focused feed
Expand Down
2 changes: 1 addition & 1 deletion metadata/en-US/short_description.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
FreeTube Cordova is an open source YouTube player built with privacy in mind.
An open source YouTube player built with privacy in mind
2 changes: 1 addition & 1 deletion metadata/fr/short_description.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
FreeTube Cordova est un lecteur YouTube open source construit avec la confidentialité à l’esprit.
un lecteur YouTube open source construit avec la confidentialité à l’esprit

0 comments on commit 1e1d004

Please sign in to comment.