Skip to content

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
SuperMarcus committed Nov 12, 2019
1 parent 4389331 commit 96d5c93
Show file tree
Hide file tree
Showing 20 changed files with 37 additions and 20 deletions.
Binary file added Misc/Media/Demo/Dark/calendar_ipad.dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Dark/library.dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Dark/library_ipad_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Dark/listing_edit.dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Dark/recents_ipad.dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Dark/watch_next.dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Dark/watch_next_ipad.dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Light/calendar_ipad.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Light/library.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Light/library_ipad.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Light/listing_edit.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Light/recents_ipad.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Light/watch_next.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/Demo/Light/watch_next_ipad.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Misc/Media/recents_long_press.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions NineAnimator.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -653,6 +653,7 @@
2CB004242200AEBC00351B7E /* OfflineContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OfflineContent.swift; sourceTree = "<group>"; };
2CB004262200B0FD00351B7E /* OfflineEpisodeContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OfflineEpisodeContent.swift; sourceTree = "<group>"; };
2CB0042822024BDA00351B7E /* CachedAnimeArtworkRetriver.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CachedAnimeArtworkRetriver.swift; sourceTree = "<group>"; };
2CB2D556237A3255009D91D1 /* recents_long_press.jpeg */ = {isa = PBXFileReference; lastKnownFileType = image.jpeg; path = recents_long_press.jpeg; sourceTree = "<group>"; };
2CB9919321FEAC5D0055B7A7 /* DetailedEpisodeTableViewCell.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DetailedEpisodeTableViewCell.swift; sourceTree = "<group>"; };
2CC2F5D1226F277B00A62A76 /* Optional+Unwrap.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Optional+Unwrap.swift"; sourceTree = "<group>"; };
2CCC745921C060480007502A /* Source.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Source.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1019,6 +1020,7 @@
children = (
2CEBE8F6220740BB006A64CC /* Demo */,
2CEA0BE921F67EB0007EECC4 /* continuity.jpg */,
2CB2D556237A3255009D91D1 /* recents_long_press.jpeg */,
2C8BCB5521E2EB7600430598 /* homekit.jpg */,
2CA1DD3E21DD5BF3009241CB /* nineanimator_banner.jpg */,
2C4817A721DB2F320092F694 /* xcode_select_device.jpg */,
Expand Down
45 changes: 25 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
<a href="https://discord.gg/dzTVzeW">
<img src="https://img.shields.io/discord/545740643247456267.svg?logo=discord&color=blue" alt="Discord Server"/>
</a>
<a href="https://testflight.apple.com/join/SzIVhF6w">
<img src="https://img.shields.io/badge/join-TestFlight-blue.svg" alt="Join TestFlight"/>
</a>
</p>
<p align="center">
<a href="https://github.com/Carthage/Carthage">
Expand Down Expand Up @@ -113,9 +116,9 @@ locally cached episodes.

<img src="Misc/Media/notification_example.jpg" width="320" />

To subscribe an anime, swipe on the anime from left to right in the Recents tab.
To subscribe an anime, long press on the anime in the Recents category of your Library.

<img src="Misc/Media/subscribe_recent_tab.jpg" width="320" />
<img src="Misc/Media/recents_long_press.jpeg" width="320" />

Or simply tap on the subscribe button when you are viewing any anime.

Expand Down Expand Up @@ -183,6 +186,8 @@ entries:
- `history`: A list of serialized `AnimeLink` objects from the recently watched tab.
- `progresses`: A dictionary keyed by the episode identifier for the persisted playback progresses.
- `exportedDate`: The `Date` that this file is generated.
- `trackingData`: A dictionary keyed by `AnimeLink` for the serialized `TrackingContext`.
- `subscriptions`: A list of serialized `AnimeLink` for your subscribed anime.

See [StatesSerialization.swift](NineAnimator/Utilities/StatesSerialization.swift) for
implementation details.
Expand All @@ -199,41 +204,41 @@ There are some limitations to NineAnimator's ability to download and playback vi

## Screenshots

### Light Appearance
### Dark Appearance

| Featured Anime | Recently Viewed | Search |
| ------------------- | ------------------- | -------- |
| ![1](Misc/Media/Demo/Light/featured.png) | ![2](Misc/Media/Demo/Light/recents.png) | ![3](Misc/Media/Demo/Light/search.png) |
| Watch Next | Library | Search |
| ------------- | -------- | -------- |
| ![1](Misc/Media/Demo/Dark/watch_next.dark.png) | ![2](Misc/Media/Demo/Dark/library.dark.png) | ![3](Misc/Media/Demo/Dark/search.png) |

| Search Results | Choose Episodes | Downloads |
| ----------------- | -------------------- | --------------- |
| ![4](Misc/Media/Demo/Light/search_results.png) | ![5](Misc/Media/Demo/Light/browse_episodes.png) | ![6](Misc/Media/Demo/Light/downloads.png) |
| ![4](Misc/Media/Demo/Dark/search_results.png) | ![5](Misc/Media/Demo/Dark/browse_episodes.png) | ![6](Misc/Media/Demo/Dark/downloads.png) |

| Featured Anime (iPad) | Picture in Picture (iPad) |
| Recents Anime (iPad) | Picture in Picture (iPad) |
| ----------------- | -------------------- |
| ![7](Misc/Media/Demo/Light/featured_ipad.png) | ![8](Misc/Media/Demo/Light/browse_episodes_ipad.png) |
| ![7](Misc/Media/Demo/Dark/recents_ipad.dark.png) | ![8](Misc/Media/Demo/Dark/browse_episodes_ipad.png) |

| Anime Information | Anime Information (iPad) |
| Anime Information | Airing Schedule (iPad) |
| ----------------- | -------------------- |
| ![9](Misc/Media/Demo/Light/information.png) | ![10](Misc/Media/Demo/Light/information_ipad.png) |
| ![9](Misc/Media/Demo/Dark/information.png) | ![10](Misc/Media/Demo/Dark/calendar_ipad.dark.png) |

### Dark Appearance
### Light Appearance

| Featured Anime | Recently Viewed | Search |
| ------------------- | ------------------- | -------- |
| ![1](Misc/Media/Demo/Dark/featured.png) | ![2](Misc/Media/Demo/Dark/recents.png) | ![3](Misc/Media/Demo/Dark/search.png) |
| Watch Next | Library | Search |
| ------------- | -------- | -------- |
| ![1](Misc/Media/Demo/Light/watch_next.light.png) | ![2](Misc/Media/Demo/Light/library.light.png) | ![3](Misc/Media/Demo/Light/search.png) |

| Search Results | Choose Episodes | Downloads |
| ----------------- | -------------------- | --------------- |
| ![4](Misc/Media/Demo/Dark/search_results.png) | ![5](Misc/Media/Demo/Dark/browse_episodes.png) | ![6](Misc/Media/Demo/Dark/downloads.png) |
| ![4](Misc/Media/Demo/Light/search_results.png) | ![5](Misc/Media/Demo/Light/browse_episodes.png) | ![6](Misc/Media/Demo/Light/downloads.png) |

| Featured Anime (iPad) | Picture in Picture (iPad) |
| Recents Anime (iPad) | Picture in Picture (iPad) |
| ----------------- | -------------------- |
| ![7](Misc/Media/Demo/Dark/featured_ipad.png) | ![8](Misc/Media/Demo/Dark/browse_episodes_ipad.png) |
| ![7](Misc/Media/Demo/Light/recents_ipad.light.png) | ![8](Misc/Media/Demo/Light/browse_episodes_ipad.png) |

| Anime Information | Anime Information (iPad) |
| Anime Information | Airing Schedule (iPad) |
| ----------------- | -------------------- |
| ![9](Misc/Media/Demo/Dark/information.png) | ![10](Misc/Media/Demo/Dark/information_ipad.png) |
| ![9](Misc/Media/Demo/Light/information.png) | ![10](Misc/Media/Demo/Light/calendar_ipad.light.png) |

### Google Cast

Expand Down
1 change: 1 addition & 0 deletions docs/credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ Most of the resources are obtained from the open domains with their respective a
- [Notification Icon](https://thenounproject.com/search/?q=notification&i=2918254)
- [Download Icon](https://thenounproject.com/search/?q=download&i=2644467)
- [History Icon](https://thenounproject.com/search/?q=history&i=2712044)
- Apple's SF Symbols
5 changes: 5 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@

To install NineAnimator, you have the following options:

- TestFlight Beta Testing
- Install from Third-Party App Stores
- Install via Cydia Impactor with Compiled IPAs
- Build from Source Code

## TestFlight Beta Testing

NineAnimator is now available via TestFlight. Join the [NineAnimator Beta Testing Program](https://testflight.apple.com/join/SzIVhF6w).

## Third-Party App Stores

NineAnimator is available on the following third-party app stores:
Expand Down
4 changes: 4 additions & 0 deletions docs/third-party-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,19 @@ Supported tracking/listing services and capabilities:
- [x] Display detailed anime information
- [x] Push local playback history to the remote service
- [x] Retrieve remote anime state and anime collections
- [x] Edit progresses via built-in editor
- [Kitsu.io](//kitsu.io)
- [ ] Display detailed anime information
- [x] Push local playback history to the remote service
- [x] Retrieve remote anime state and anime collections
- [ ] Edit progresses via built-in editor
- [MyAnimeList](//myanimelist.net)
- [x] Display detailed anime information
- [x] Push local playback history to the remote service
- [x] Retrieve remote anime state and anime collections
- [x] Edit progresses via built-in editor
- [Simkl.com](//simkl.com)
- [ ] Display detailed anime information
- [x] Push local playback history to the remote service
- [x] Retrieve remote anime state and anime collections
- [ ] Edit progresses via built-in editor

0 comments on commit 96d5c93

Please sign in to comment.