Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Saektide committed Dec 24, 2020
1 parent eb2ffe4 commit 4314847
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 11 deletions.
52 changes: 41 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,39 @@
<p align="center">
<img src="https://i.imgur.com/WeGT7LA.png" width="100%">
</p>

# e6Hub
[![Build status](https://ci.appveyor.com/api/projects/status/eawhvp0h2215rqhj?svg=true)](https://ci.appveyor.com/project/Saektide/app)
[![DeepScan grade](https://deepscan.io/api/teams/9325/projects/11662/branches/175184/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=9325&pid=11662&bid=175184)

This is an app for explore and download posts on [e621.net](https://e621.net/help/about). It uses [e621's API](https://e621.net/wiki_pages/2425) and it's powered by [Vue.js](https://vuejs.org/). Feel free to contribute to this project!
Wanna bring e621 to your desktop? You got it, e6Hub is an app that allows you to fetch posts, pools and download them from [e621.net](https://e621.net/help/about). It uses [e621's API](https://e621.net/wiki_pages/2425) and it's powered by [Vue.js](https://vuejs.org/). Feel free to contribute to this project!

* [Download](https://github.com/e6Hub/app/releases/latest)
* [Changelog](https://github.com/e6Hub/app/blob/master/CHANGELOG.md#changelog)

### 💭 Keep in mind...
* This app interacts with a NSFW site, so, if you don't like to see explicit content... use `rating:s` while you are searching posts. Learn more about [e621's tag system](https://e621.net/help/tags).
* This app interacts with a NSFW site, so, if you don't want to see explicit content... use `rating:s` while you are searching posts or use the blur feature. Learn more about [e621's tag system](https://e621.net/help/tags).
* Posts (images, animations, videos) are from e621, some are uploaded by his own artist.

## 🌟 Features
* Fetch, list (save temporally on your session) and download posts and polls
* SWF support (see [FAQ](#FAQ) for how to enable it)
* Webm support
* Third party plugins support
* Blur explicit images
* DText support

## 📸 Showcase / Screenshot
<p align="center">
<img src="assets/screenshots/e6HubShowcase1.gif">
</p>

## 🖥 Machine requirements
| Component | Minimum | Recommended |
| --- | ---: | ---: |
| RAM | 2 GB | 4 GB |
| Storage | ~150 MB | 250 MB |
| CPU | 1.80 Ghz - Single Core (Intel Celeron) | 3.00 Ghz - Dual Core (AMD Athlon x2) |
| CPU |Any single core CPU | Any dual core CPU |
| Bandwidth Downstream | 1 MiB | 3 MiB |

## 🧪 OS Supported
> **Note** We release only 64bit versions
> **Note** We release only 64 bits versions
| OS Name | Status | Type |
| ---------- | :----: | ---: |
Expand All @@ -36,7 +46,7 @@ This is an app for explore and download posts on [e621.net](https://e621.net/hel
| macOS || .dmg |

* ✔ Supported
* ❌ Not supported but it can be build
* ❌ Not supported but can compile it
* ✖ Unstable
* ⚠ Not tested yet
* :heavy_exclamation_mark: Unstable since some version of Electron (mostly Electron 6 or 8)
Expand Down Expand Up @@ -78,5 +88,25 @@ or
npm run build
```

## ⚠ Any issue or feedback?
You can tell it at [Issues](https://github.com/e6Hub/app/issues).
## ❓ FAQ

### Can i download multiple pools/posts at the same time?
You can download only one pool at the time. e6Hub will mark posts (and pools) as "pending" to avoid saturate e621's servers.

### Can i see blacklisted posts on this app?
No, e621's global blacklist works on server-side too. In a near future we may include Log In system but isn't necessary at this moment.

### e6Hub have telemetry?
No. And we wont include that feature on our app.

### I want to report a bug or give my feedback, where should i go?
Use the **Issues** section for bug report (if you are not sure if that's a bug or a feature you can ask on Discussions), for feedbacks you can use **Discussions** and Issues too.

### There's premium functions in this app?
No, all the app (and everything on there) is free and open source.

### How do i enable SWF on this app?
Assuming your machine have Windows (7 or greater), Adobe no longer support Flash right now but you still have the possibility to install it on your machine. e6Hub will be able to play SWF posts if you have the proprietary Pepper Flash Player plugin installed and located at `C:Windows\System32\Macromed\Flash`.

### I have questions that doesn't apply to the FAQ...
You can use **Discussions** and you will receive support from a experimental user or from a project contributor. We don't bite!
Binary file added assets/screenshots/e6HubShowcase1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4314847

Please sign in to comment.