web/notify.moe
Code Issues Pull Requests Activity

Updated readme

Browse Source
This commit is contained in:
Eduard Urbach 2018-03-18 18:04:35 +01:00
parent f2a4af9ea8
commit 27197a4e41
1 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -23,22 +23,26 @@ In the past it was, but not anymore. We're growing bigger by establishing a data
## What does the current feature set look like? ## What does the current feature set look like?
* [Chrome extension](https://chrome.google.com/webstore/detail/anime-notifier/hajchfikckiofgilinkpifobdbiajfch) for quick watching list access and episode updates * [Chrome extension](https://chrome.google.com/webstore/detail/anime-notifier/hajchfikckiofgilinkpifobdbiajfch) for quick watching list access and episode updates
* Edit episode progress and rating by clicking on the number * [Unrivaled](https://www.webpagetest.org/results/video/18/03/18/6071a7292ed1dd4602d30d13b31e1a89ec430b1d/video.mp4) page loading times
* High quality, multi-DPI images loading super-fast
* Smooth page transitions optimized for 144+ Hz monitors
* Looks good on 1080p, 720p and on mobile devices
* Airing dates * Airing dates
* Offline browsing
* Push notifications * Push notifications
* Light & Dark theme
* Offline browsing
* Anime radio
* Search
* User profiles
* Forums
* Soundtracks * Soundtracks
* Anime & user search * Quotes
* Anime rating system * Companies
* Detailed anime rating system
* [twist.moe](https://twist.moe) integration * [twist.moe](https://twist.moe) integration
* [anilist.co](https://anilist.co/), [myanimelist.net](https://myanimelist.net/) and [kitsu.io](https://kitsu.io/) import * [anilist.co](https://anilist.co/), [myanimelist.net](https://myanimelist.net/) and [kitsu.io](https://kitsu.io/) import
* [osu](https://osu.ppy.sh/) ranking view * [osu](https://osu.ppy.sh/) ranking view
* [Gravatar](https://gravatar.com) support * [Gravatar](https://gravatar.com) support
* High quality images that are small in file size (WebP)
* User profiles
* Dashboard
* Forums
* Responsive layout (looks good on 1080p and on mobile devices)
## Can I follow the project on social media? ## Can I follow the project on social media?
@ -48,6 +52,10 @@ In the past it was, but not anymore. We're growing bigger by establishing a data
* [GitHub](https://github.com/animenotifier/notify.moe) * [GitHub](https://github.com/animenotifier/notify.moe)
* [Discord](https://discord.gg/0kimAmMCeXGXuzNF) * [Discord](https://discord.gg/0kimAmMCeXGXuzNF)
## Where can I read the Terms of Service?
You automatically agree to the [Terms of Service](https://notify.moe/terms) by visiting and using this site.
## How do I enable notifications? ## How do I enable notifications?
Use a browser that supports push notifications (Chrome or Firefox). Then go to your [settings](https://notify.moe/settings) and click "Enable notifications". This might take a while, especially on mobile devices. After that you can press "Send test notification". If you get a notification saying "Yay, it works!" then everything's fine. The real thing looks like this: Use a browser that supports push notifications (Chrome or Firefox). Then go to your [settings](https://notify.moe/settings) and click "Enable notifications". This might take a while, especially on mobile devices. After that you can press "Send test notification". If you get a notification saying "Yay, it works!" then everything's fine. The real thing looks like this:
@ -86,6 +94,10 @@ You can rate each entry in your anime list in 4 different categories:
Each rating is a number on a scale of 0 to 10. A rating of 0 counts as "not rated" and will be ignored in average rating calculations for that anime. Thus the lowest possible rating you can assign to an anime is 0.1. The highest possible rating is 10. The average is close to the number 5. Each rating is a number on a scale of 0 to 10. A rating of 0 counts as "not rated" and will be ignored in average rating calculations for that anime. Thus the lowest possible rating you can assign to an anime is 0.1. The highest possible rating is 10. The average is close to the number 5.
## How do I add a soundtrack?
Go to [soundtracks](https://notify.moe/soundtracks) and press the "Add soundtrack" button. Then add a title, media and tags for the track. For media you need to select a service (e.g. Youtube) and enter the ID of the video (usually at the end of the link). You can link it with an anime by adding an "anime:ID" tag where you replace ID with the anime ID. Once you're happy with the result, press "Publish".
## What does the Chrome extension offer me? ## What does the Chrome extension offer me?
A quick access to your watching list: A quick access to your watching list:
@ -167,10 +179,14 @@ Go to your [settings](https://notify.moe/settings), it should show you the remai
## Are there any hotkeys? ## Are there any hotkeys?
* Press "F" to search the site for anime or other content * Press "F" to search the site for anime or other content
* Press "S" to hide or show the sidebar
* Press "K" to start/pause anime radio
* Press "J" or "L" for previous and next track respectively
* Press "+" or "-" to change audio playback speed
## Is this website well-optimized? ## Is this website well-optimized?
Take a look at the comparison of [notify.moe, kitsu.io, anilist.co and myanimelist.net](https://www.webpagetest.org/video/compare.php?tests=171111_CA_e6d20ca33741ffb9e7e61456b588111d,171111_NW_15a380b66a64fe57bad2f656bcec3bf9,171111_SD_2bced86a01dc94a9608385beeb823230,171111_EC_381395feb27de2e8047cd821b8add5bf) loading speeds. Take a look at the comparison of [notify.moe, kitsu.io, anilist.co and myanimelist.net](https://www.webpagetest.org/results/video/18/03/18/6071a7292ed1dd4602d30d13b31e1a89ec430b1d/video.mp4) loading speeds.
![Anime Notifier - Lighthouse](https://pbs.twimg.com/media/DEplUsNXgAEF-UT.jpg:large) ![Anime Notifier - Lighthouse](https://pbs.twimg.com/media/DEplUsNXgAEF-UT.jpg:large)