Welcome to the Minion project! Control your Popcorn Time client on your phone or tablet with ease, using Minion.
This readme is the main source of documentation for everyone working with (or contributing to) the Minion project.
If you think that you found a bug, encountered a problem or have an idea that could help out the project, please search for your issue or feature in the issue tracker before posting. Once you are sure that no-one posted your issue before, read the contributing guidelines and then create a new issue or pull request.
To get started with Minion, choose one of the options below.
- Use the live version.
- Download the latest release.
- Clone the repository:
git clone https://github.com/lesander/minion.git.
Minion will not work correctly in file:// mode, instead use a (local) webserver (Apache, Nginx, Jekyll).
When you run into a problem, please check the issue tracker if someone has had the same problem. If your problem has not been addressed yet, please open a new issue.
To start using Minion, you'll of course need Popcorn Time (not time4popcorn or a different fork). When you open Minion for the first time, it'll ask you for the connection settings of your Popcorn Time app. You can find your connection settings inside the Popcorn Time app, under Settings (the cog icon) -> Show advanced settings -> Remote Control. Once you've filled out the settings, click save.
Keep track of news and development about Minion:
- Follow @lesander_ on Twitter.
- Star project Minion on GitHub.
- Follow lesander on GitHub.
For transparency into our release cycle and in striving to maintain backward compatibility, Minion is maintained under the Semantic Versioning guidelines as much as possible.
Code and documentation copyright 2014 The PTR Team. Code released under the GNU GPL v3 license. Documentation released under Creative Commons.
Logo created by Ankit Joshi, © 2013-2014. All rights reserved.
If you distribute a copy or make a fork of this project, you have to credit this project as source, it's that simple.
This program is free software (yay!): you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this project. If not, see http://www.gnu.org/licenses/.