Documentation update

.github/ISSUE_TEMPLATE/discussion.md

@@ -0,0 +1,22 @@
+---
+name: Discussion
+about: Open up a new discussion about anything related to the project.
+title: ''
+labels: Discussion
+assignees: ''
+
+---
+
+**Important note**
+Please check other open and closed issues for a similar discussion or a question relating to your discussion before posting a new one. 
+
+**Topic**
+Please select what topic your discussion is about.
+- [ ] Coding
+- [ ] Contribution
+- [ ] Languages
+- [ ] Setup
+- [ ] Other. Please specify:
+
+**Discussion**
+Please write down whatever you want to discuss.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,22 @@
+---
+name: Question
+about: Ask a question which is not a bug or a feature request
+title: ''
+labels: question
+assignees: ''
+
+---
+
+**Important note**
+Please check other open and closed issues for a similar question before posting a new one. 
+
+**Topic**
+Please select what topic you are referring to.
+- [ ] Coding
+- [ ] Contribution
+- [ ] Languages
+- [ ] Setup
+- [ ] Other. Please specify:
+
+**Question**
+Please write down your question.

README.md

@@ -1,71 +1,24 @@
-
-## How to install
-
-Currently, the best version of this app is the PWA because it has no issues with background play and receives continuous updates automatically. The APK can be finicky if you move the app into the background while the video is playing, and it doesn't automatically update.
-
-There is a PWA (progressive web app) available here:
-
-[https://marmadilemanteater.github.io/freetube/#/](https://marmadilemanteater.github.io/freetube/#/)
-
-There is an APK which can be downloaded here:
-
-[https://github.com/MarmadileManteater/FreeTubeCordova/releases](https://github.com/MarmadileManteater/FreeTubeCordova/releases)
-
-
-## How to build and test:
-
-```bash
-    npm run pack:browser
-    # This creates the cordova project, 
-    # copies the dist folder, browserifies 
-    # it, and replaces a bunch of functions
-    # with cordova equivalents.
-    # After your first build, most of the
-    # build components will be recycled
-    # from that build.
-    npm run build:cordova
-    # This opens up the cordova application 
-    # in a web browser
-    npm run run:cordova browser
-    # This opens up the cordova application
-    # on an android device connected with 
-    # debugging enabled
-    npm run run:cordova android
-```
-
-#
-
 <p align="center" >
  <img src="https://docs.freetubeapp.io/images/logoColor.png" width=500 align="center">
 </p>
 
-FreeTube is an open source desktop YouTube player built with privacy in mind.
-Use YouTube without advertisements and prevent Google from tracking you with their cookies and JavaScript.
-Available for Windows, Mac & Linux thanks to Electron.
+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://github.com/FreeTubeApp/FreeTube/releases">Download FreeTube</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="#download-links">Download Links</a> &bull; <a href="#contributing">Contributing</a> &bull; <a href="#localization">Localization</a> &bull; <a href="#contact">Contact</a> &bull; <a href="#donate">Donate</a> &bull; <a href="#license">License</a></p>
+<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>
 
-<b>Please note that FreeTube is currently in Beta. While it should work well for most users, there are still bugs and missing features that need to be addressed. If you have an idea or if you found a bug, please submit a [GitHub issue](https://github.com/FreeTubeApp/FreeTube/issues/new/choose) so that
-we can track it.  Please search [the existing issues](https://github.com/FreeTubeApp/FreeTube/issues) before submitting to
-prevent duplicates!</b>
-
-## Screenshots
-<img src="https://i.imgur.com/zFgZUUV.png" width=300> <img src="https://i.imgur.com/9evYHgN.png" width=300> <img src="https://i.imgur.com/yT2UzPa.png" width=300> <img src="https://i.imgur.com/47zIEt4.png" width=300> <img src="https://i.imgur.com/hFB2fKC.png" width=300>
-
 ## How does it work?
-FreeTube uses a built in extractor to grab and serve data / videos.  The [Invidious API](https://github.com/iv-org/invidious) can also optionally be used.  FreeTube does not use any official APIs to obtain data.  While YouTube can still see your video requests, it can no
-longer track you using cookies or JavaScript. Your subscriptions and history are stored locally on your computer and never sent out.  Using a VPN or Tor is highly recommended
-to hide your IP while using FreeTube.
+FreeTube Cordova uses the [Invidious API](https://github.com/iv-org/invidious) to serve data and videos. 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
-* Two extractor APIs to choose from (Built in or Invidious)
 * Subscribe to channels without an account
 * Connect to an externally setup proxy such as Tor
 * View and search your local subscriptions, history, and saved videos
@@ -75,7 +28,6 @@ to hide your IP while using FreeTube.
 * Youtube Chapters
 * Most popular videos page based on the set Invidious instance
 * SponsorBlock 
-* Open videos from your browser directly into FreeTube (with extension)
 * Watch videos using an external player
 * Full Theme support
 * Make a screenshot of a video
@@ -85,66 +37,70 @@ to hide your IP while using FreeTube.
 * Option to show only family friendly content
 * Show/hide functionality or elements within the app using the distraction free settings
 
-### Browser Extension
-FreeTube is supported by the [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect) and [LibRedirect](https://github.com/libredirect/libredirect) extensions, which will allow you to open YouTube links into FreeTube. You must enable the option within the advanced settings of the extension for it to work.
-
-* Download Privacy Redirect for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/privacy-redirect/) or [Google Chrome](https://chrome.google.com/webstore/detail/privacy-redirect/pmcmeagblkinmogikoikkdjiligflglb).
-
-* Download LibRedirect for [Firefox](https://addons.mozilla.org/firefox/addon/libredirect/) or [Google Chrome](https://github.com/libredirect/libredirect/blob/master/chromium.md).
+Go to [FreeTube's Documentation](https://docs.freetubeapp.io/) if you'd like to know more about how to operate FreeTube and its features.
 
-If you have issues with the extension working with FreeTube, please create an issue in this repository instead of the extension repository. This extension does not work on Linux portable builds!
-
-## Download Links
-### Official Downloads
-* [GitHub Releases](https://github.com/FreeTubeApp/FreeTube/releases)
+## Screenshots
+<img alt="watching video" src="./metadata/en-US/images/phoneScreenshots/1.png" width=300> <img alt="trending videos" src="./metadata/en-US/images/phoneScreenshots/2.png" width=300> <img alt="subscription feed" src="./metadata/en-US/images/phoneScreenshots/3.png" width=300>
 
-* [FreeTube Website](https://freetubeapp.io/#download)
+## How to install
 
-* Flatpak on Flathub: [Download](https://flathub.org/apps/details/io.freetubeapp.FreeTube) [Source](https://github.com/flathub/io.freetubeapp.FreeTube)
+There is a deployed PWA (progressive web app) available here:
 
-#### Automated Builds (Nightly / Weekly)
-Builds are automatically created from changes to our development branch via [GitHub Actions](https://github.com/FreeTubeApp/FreeTube/actions?query=workflow%3ABuild).
+[https://marmadilemanteater.github.io/freetube/#/](https://marmadilemanteater.github.io/freetube/#/)
 
-The first build with a green check mark is the latest build.  You will need to have a GitHub account to download these builds.
+There is an APK which can be downloaded here:
 
-### Unofficial Downloads
-These builds are maintained by the community.  While they should be safe, download at your own risk.  There may be issues with using these versus the official builds.  Any issues specific with these builds should be sent to their respective maintainer.
+[https://github.com/MarmadileManteater/FreeTubeCordova/releases](https://github.com/MarmadileManteater/FreeTubeCordova/releases)
 
-* Arch User Repository (AUR): [Download](https://aur.archlinux.org/packages/freetube-bin/)
+## How to build and test
 
-* Chocolatey: [Download](https://chocolatey.org/packages/freetube/)
+```bash
+    yarn pack:browser
+    # This creates the cordova project, 
+    # copies the dist folder, browserifies 
+    # it, and replaces a bunch of functions
+    # with cordova equivalents.
+    # After your first build, most of the
+    # build components will be recycled
+    # from that build.
+    yarn build:cordova
+    # This opens up the cordova application 
+    # in a web browser
+    yarn run:cordova browser
+    # This opens up the cordova application
+    # on an android device connected with 
+    # debugging enabled
+    yarn run:cordova android
+```
 
-* makedeb Package Repository (MPR): [Download](https://mpr.makedeb.org/packages/freetube-bin)
+#### 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).
 
-* PortableApps (Windows Only): [Download](https://github.com/rddim/FreeTubePortable/releases) [Source](https://github.com/rddim/FreeTubePortable)
+The first build with a green check mark is the latest build. You will need to have a GitHub account to download these builds.
 
-* Scoop (Windows Only): [Usage](https://github.com/ScoopInstaller/Scoop)
+## Contributing
 
-* Windows Package Manager (winget): [Usage](https://docs.microsoft.com/en-us/windows/package-manager/winget/)
+**NOTICE: MOST CHANGES SHOULD PROBABLY BE MADE TO [UPSTREAM](https://www.github.com/freetubeapp/freetube) UNLESS DIRECTLY RELATED TO CORDOVA CODE OR WORKFLOWS.**
 
-## Contributing
 If you like to get your hands dirty and want to contribute, we would love to
 have your help.  Send a pull request and someone will review your code. Please
 follow the [Contribution
-Guidelines](https://github.com/FreeTubeApp/FreeTube/blob/development/CONTRIBUTING.md)
+Guidelines](https://github.com/MarmadileManteater/FreeTubeCordova/blob/development/CONTRIBUTING.md)
 before sending your pull request.
 
-Thank you very much to the [People and Projects](https://docs.freetubeapp.io/credits/) that make FreeTube possible!
 
 ## Localization
 <a href="https://hosted.weblate.org/engage/free-tube/">
 <img src="https://hosted.weblate.org/widgets/free-tube/-/287x66-grey.png" alt="Translation status" />
 </a>
 
-We are actively looking for translations!  We use [Weblate](https://hosted.weblate.org/engage/free-tube/) to make it easy for translators to get involved.  Click on the badge above to learn how to get involved.
-
-For the Linux Flatpak, the desktop entry comment string can be translated at our [Flatpak repository](https://github.com/flathub/io.freetubeapp.FreeTube/blob/master/io.freetubeapp.FreeTube.desktop).
+If you'd like to localize FreeTubeCordova, please send submissions to [FreeTube's weblate](https://hosted.weblate.org/engage/free-tube/)
 
 ## Contact
-If you ever have any questions, feel free to ask it on our [Discussions](https://github.com/FreeTubeApp/FreeTube/discussions) page.  Alternatively, you can email us at [email protected] or you can join our [Matrix Community](https://matrix.to/#/+freetube:matrix.org).  Don't forget to check out the [rules](https://docs.freetubeapp.io/community/matrix/) before joining.
+If you ever have any questions, feel free to make an issue here on GitHub. 
 
-## Donate
-If you enjoy using FreeTube, you're welcome to leave a donation using the following methods.  
+## Upstream Donations
+If you enjoy using FreeTubeCordova, you're welcome to leave a donation using the following methods to support upstream development and maintenance.  
 
 * [FreeTube on Liberapay](https://liberapay.com/FreeTube)
 

metadata/en-US/changelogs/default.txt

@@ -0,0 +1 @@
+First release

metadata/en-US/full_description.txt

@@ -0,0 +1,17 @@
+FreeTube Cordova is a YouTube client that uses the Invidious API to serve data and videos from YouTube.
+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
+- Export and import subscriptions from a variety of sources (Ex: YouTube, NewPipe, Invidious)
+- Support for SponsorBlock
+- Support for Comments and Replies
+- Support for YouTube Chapters
+- Option to password protect settings
+- Parental controls
+- Subscribe to channels without an account
+
+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.

metadata/en-US/short_description.txt

@@ -0,0 +1 @@
+FreeTube Cordova is an open source YouTube player built with privacy in mind.

metadata/en-US/title.txt

@@ -0,0 +1 @@
+FreeTubeCordova

metadata/fr/short_description.txt

@@ -0,0 +1 @@
+FreeTube Cordova est un lecteur YouTube open source construit avec la confidentialité à l’esprit.