add README.md

1 files changed, 58 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da5ecc0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# Android myanimelist client project. (WIP)
+
+## 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
++ /v3/top/anime
++ /v3/manga
++ /v3/anime
++ /v3/search/manga
++ /v3/search/anime
+
+## 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
++ very light magenta : #FF70FF
++ strong pink : #D52C70
++ slightly desaturated magenta : #C583B6
++ grayish magenta : #C9A6C9
+
+Also added the "bangers" font for the titles.
+
+## Gitflow
+Development done with a Gitflow workflow. I used master, release, develop and feature branches.
+
+## Architecture
+I used the MVC architecture.
+
+## TO-DO
++ Finishing MVC
++ Adding Singleton
++ Clicking on an image opens it full size
++ Firebase
++ Bottom navigation
++ ...