aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorClyhtsuriva <aimeric@adjutor.xyz>2021-05-14 15:42:33 +0200
committerClyhtsuriva <aimeric@adjutor.xyz>2021-05-14 15:42:33 +0200
commit40e37d6da02a74aa7be94b73c6cfc4e44697f9e7 (patch)
tree7ec56756e5b0a4402180ec48896a13f50c6b78a3 /README.md
parent6484782745a29752cf2a9a5015b34494513eb376 (diff)
parent5660a3da8c24b2e40eab08045f9fe14266569f8a (diff)
Merge branch 'release/3.1.1'v3.1.1
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9670ac9..6e7e46b 100644
--- a/README.md
+++ b/README.md
@@ -3,22 +3,36 @@
## Features
List of elements used in top manga and top anime with a recycler view
+
SwipeRefresh used to refresh the list of data of the first page.
+
Use the button (prev and next) to navigate with ease through the pages.
+
+
Details of a chosen element from the recycler view with an intent object
+
Title, synopsys and background clickable.
+
URL link openable.
+
+
Search pages for animes and mangas.
+
They display the data in a recycler view similar to the tops.
+
A feature has been added that hides the keyboard when the query is submitted by the user.
+
We can also submit the query by clicking the "search" button that replace the "return" one.
+
Clicking on a searched item also opens a detail page of it.
+
I'm not adding the "multiple pages" feature to the search section because I assume the user should use a more precise query if what he's looking for doesn't show up in the first page.
## API
Multiple calls of the REST API from jikan.moe.
+
Usage of :
+ /v3/top/manga
@@ -30,11 +44,14 @@ Usage of :
## Data Storage
Data storage with sharedpreferences used for the recycler view of top manga and top anime as well as the details
+
Saves the detail page of an item when opened, not when the list is shown
+
Usage of ScrollView in the detail page. Thus, items with long synopsis and background aren't cut down.
## Design
Used my "personal" theme colors for the app.
+
It consists of some colors of the pink/purple "family" :
+ very dark purple : #09022A
@@ -53,4 +70,10 @@ I used the MVC (Model, View, Controller) architecture.
## Singletons
Usage of singletons.
+
Used to call APIs.
+
+## Usage
+Displaying a snack when hitting the previously button on the first page :
+![Previous_button_on_first_page](https://adjutor.xyz/gif/prev-button-message.gif)
+This is a reminder since there's a bug (or a feature ;) ) that reset the page number inside the app/code but not the actual list displayed.