Update README and add media

Signed-off-by: kingbri <bdashore3@proton.me>
This commit is contained in:
kingbri 2024-06-13 23:10:30 -04:00
parent 5223c60acd
commit 0d39fd481a
11 changed files with 81 additions and 8 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 212 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 539 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 206 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 210 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 143 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 475 KiB

View file

@ -1,5 +1,25 @@
# Ferrite
<p align="left">
<a href="https://ko-fi.com/I2I3BDTSW">
<img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Donate on Ko-Fi">
</a>
<img src="https://img.shields.io/badge/Swift-5.10-orange.svg" alt="Swift 5.2"/>
<img src="https://img.shields.io/badge/platform-iOS%20%7C%20macCatalyst-lightgrey" alt="Platform: iOS | iPadOS"/>
<a href="/LICENSE">
<img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3"/>
</a>
</p>
<p align="left">
<a href="https://github.com/Ferrite-iOS/Ferrite/actions/workflows/nightly.yml">
<img src="https://github.com/Ferrite-iOS/Ferrite/actions/workflows/nightly.yml/badge.svg?branch=next" alt="Nightly Build Status"/>
</a>
<a href="https://discord.gg/sYQxnuD7Fj">
<img src="https://img.shields.io/discord/545740643247456267.svg?logo=discord&color=blue" alt="Discord Server"/>
</a>
</p>
A media search engine for iOS with a plugin API to extend its functionality.
## Disclaimer
@ -16,31 +36,62 @@ However, the main problem is that these websites tend to suck in terms of UI or
I also wanted to support the use of debrid services since there aren't any (free) options on iOS that have support for this service.
## Features
- [x] Ad-free
- [x] Clean UI with native performance
- [x] Powerful search with an intuitive filter system
- [x] Modular plugin system
- [x] Integrates with many debrid providers
- [x] Flexible parser system written in native Swift
- [x] Local library with bookmarks and history
- [x] Manage your debrid cloud
- [x] Does not pollute your debrid cloud
- [x] Kodi integration
If there's a feature that's not listed here, open an issue or ask in the support Discord.
## What iOS versions are supported?
To decide what minimum version of iOS is supported, Ferrite follows an "n - 2" patten. For example, if iOS 18 is the latest version, the minimum supported iOS version is 16 (18-2 = 16).
To make this easier, the minimum required iOS version and Ferrite versions are listed below:
- v0.8 and up: iOS 16 and up
- v0.7 and up: iOS 15 and up
- v0.6.x and lower: iOS 14 and up
## Planned features
## Supported debrid services
More of these can be found in [issues](https://github.com/bdashore3/Ferrite/issues), but here is a small snippet:
Ferrite primarily uses Debrid services for instant streaming. A list of supported services are provided below:
- More involved search filtering
- RealDebrid
- AllDebrid
- Premiumize
- TorBox
- OffCloud
- Companion apps for playback on other devices
Want another debrid service? Make a request in issues or the support Discord.
## Downloads
Ferrite will only exist as an ipa. There will never be any plans to release on TestFlight or the App Store. Ipa builds are automatically built and are provided in Github actions artifacts.
At this time, Ferrite will only exist as an ipa. There are no plans to release on TestFlight or the App Store. Ipa builds are automatically built and are provided in Github actions artifacts.
## Plugins/Sources
Sources are not provided by the application. They must be found from external means or you can make them yourself using the [wiki](https://github.com/bdashore3/Ferrite/wiki). Various communities have created sources for Ferrite and they can be imported in the app with ease.
Plugins are not provided by the application. They must be found from external means or you can make them yourself using the [wiki](https://github.com/bdashore3/Ferrite/wiki). Various communities have created sources for Ferrite and they can be imported in the app with ease.
There are two types of plugins:
- Source: A plugin that looks something up in an indexer
- Action: A plugin that "does" something, such as opening a result in a separate application
To start off, a plugin list is located here (you can copy and paste this in the app) -> [https://raw.githubusercontent.com/Ferrite-iOS/example-sources/default/public-domain-plugins.yml](https://raw.githubusercontent.com/Ferrite-iOS/example-sources/default/public-domain-plugins.yml)
## Building from source
Xcode 14 must be used.
Use the latest stable version of Xcode.
There are currently two branches in the repository:
@ -67,7 +118,7 @@ If you have issues with the app:
- Describe the issue in detail
- If you have a feature request, please indicate it as so. Planned features are in a different section of the README, so be sure to read those before submitting.
- Please join [the discord](https://discord.gg/sYQxnuD7Fj) for more info
- Please join [the discord](https://discord.gg/sYQxnuD7Fj) for more info and support
## Developers and Permissions
@ -80,3 +131,25 @@ Developer Website: [kingbri.dev](https://kingbri.dev)
Developer Discord: kingbri#6666
Join the support discord here: [Ferrite Discord](https://discord.gg/sYQxnuD7Fj)
## Screenshots
### Dark Mode
| Search | Bookmarks | History |
| ------------- | -------- | -------- |
| ![1](Misc/Media/Demo/Dark/Search.png) | ![2](Misc/Media/Demo/Dark/Bookmarks.png) | ![3](Misc/Media/Demo/Dark/History.png) |
| Debrid Cloud | Plugins |
| ----------- | -------------------- |
| ![4](Misc/Media/Demo/Dark/Cloud.png) | ![5](Misc/Media/Demo/Dark/Plugins.png) |
### Light Mode
| Search | Bookmarks | History |
| ------------- | -------- | -------- |
| ![1](Misc/Media/Demo/Light/Search.png) | ![2](Misc/Media/Demo/Light/Bookmarks.png) | ![3](Misc/Media/Demo/Light/History.png) |
| Debrid Cloud | Plugins |
| ----------- | -------------------- |
| ![4](Misc/Media/Demo/Light/Cloud.png) | ![5](Misc/Media/Demo/Light/Plugins.png) |