Skip to content

Commit c25d51e

Browse files
authored
📝 Update README
1 parent 04543b5 commit c25d51e

File tree

1 file changed

+43
-14
lines changed

1 file changed

+43
-14
lines changed

README.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
11
![GitHub Cards Preview](https://github.com/agustiyann/Manime/blob/main/preview/manime.jpeg?raw=true)
22

33
# Manime
4+
![Minimum API](https://img.shields.io/badge/API-21%2B-%2300cec9?style=flat-square)
45
[![GitHub license](https://img.shields.io/github/license/agustiyann/Manime?style=flat-square)](https://github.com/agustiyann/Manime/blob/main/LICENSE)
5-
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/agustiyann/Manime/Android%20CI?logo=github&style=flat-square)
6+
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/agustiyann/Manime/Android%20CI?logo=github&style=flat-square)](https://github.com/agustiyann/Manime/actions)
67
[![GitHub issues](https://img.shields.io/github/issues/agustiyann/Manime?style=flat-square)](https://github.com/agustiyann/Manime/issues)
8+
[![Kotlin](https://img.shields.io/badge/Language-Kotlin-blue?logo=kotlin&style=flat-square)](https://kotlinlang.org)
9+
[![GitHub](https://img.shields.io/badge/GitHub-agustiyann-%2300b894?logo=github&style=flat-square)](https://github.com/agustiyann)
710

811
Manime is an application to view the most popular and newest anime list and to view anime list based on season, there are complete details about the anime. Based on MVVM,
912
architecture component, and repository pattern.
1013

1114
<img src="/preview/manime.gif" align="right"/>
1215

1316
## Features
17+
All data is taken from [Jikan API](https://jikan.moe), for documentation can be seen [here](https://jikan.docs.apiary.io).
1418
- Top Anime
1519
- Airing
1620
- Upcoming
@@ -25,19 +29,44 @@ architecture component, and repository pattern.
2529
- Search
2630

2731
## Tech Stack
28-
- Kotlin
32+
- [Kotlin](https://kotlinlang.org/) based
2933
- MVVM Architecture
3034
- Architecture component
3135
- Repository Pattern
32-
- ViewModel
33-
- LiveData
34-
- Data Binding
35-
- Navigation Component
36-
- Coroutine
37-
- Retrofit
38-
- Moshi
39-
- OkHttp3
40-
- Glide
41-
- Material Design
42-
- Lottie
43-
- Shimmer
36+
- [ViewModel](https://developer.android.com/topic/libraries/architecture/viewmodel) - UI related data holder, lifecycle aware.
37+
- [LiveData](https://developer.android.com/topic/libraries/architecture/livedata) - notify domain layer data to views.
38+
- [Data Binding](https://developer.android.com/topic/libraries/data-binding)
39+
- [Navigation Component](https://developer.android.com/guide/navigation) - navigate across, into, and back out from the different pieces of content within your app.
40+
- [Coroutines](https://github.com/Kotlin/kotlinx.coroutines)
41+
- [Retrofit2](https://github.com/square/retrofit) - construct the REST APIs and paging network data.
42+
- [Moshi](https://github.com/square/moshi) - A modern JSON library for Kotlin and Java.
43+
- [OkHttp3](https://square.github.io/okhttp/)
44+
- [Glide](https://github.com/bumptech/glide) - loading images.
45+
- [Material-Components](https://github.com/material-components/material-components-android) - Material design components.
46+
- [Lottie](https://lottiefiles.com/) - displays animation in JSON format.
47+
- [Shimmer](https://facebook.github.io/shimmer-android/) - create a shimmer effect on the application.
48+
49+
## Contribute
50+
If you want to contribute to this repository, you're always welcome!
51+
52+
## To Do
53+
- [ ] Implement [Flow](https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines.flow/)
54+
- [ ] Add [Hilt](https://developer.android.com/training/dependency-injection/hilt-android) for dependecy injection
55+
- [ ] Add instrumental test
56+
- [ ] Add unit test
57+
58+
## License
59+
```
60+
Copyright (C) 2020 Agus Tiyansyah Syam
61+
Licensed under the Apache License, Version 2.0 (the "License");
62+
you may not use this file except in compliance with the License.
63+
You may obtain a copy of the License at
64+
65+
http://www.apache.org/licenses/LICENSE-2.0
66+
67+
Unless required by applicable law or agreed to in writing, software
68+
distributed under the License is distributed on an "AS IS" BASIS,
69+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
70+
See the License for the specific language governing permissions and
71+
limitations under the License.
72+
```

0 commit comments

Comments
 (0)