Skip to content

Commit 95d8386

Browse files
committed
docs: create a README.md
1 parent ea2a677 commit 95d8386

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
2+
# Using DiffUtils In A Recyclerview
3+
This is an application that is part of a technical article. You can read the article from here
4+
# Table Of Contents
5+
6+
* [About the App](#AboutTheApp)
7+
8+
* [General Preview](#general-preview)
9+
10+
* [Architecture](#architecture)
11+
12+
* [Permissions](#permissions)
13+
14+
* [Run Project](#run-locally)
15+
16+
* [Installation](#installation)
17+
18+
* [Dependencies](#dependencies)
19+
20+
* [Authors](#todo)
21+
22+
* [License](#license)
23+
24+
## About the App
25+
The app displays a list of Disney character names and images using DiffUtils:
26+
27+
## General Preview
28+
29+
<a href="url">< height="550" ></a>
30+
31+
## Permissions
32+
33+
You need to allow the internet permissions before running the app:
34+
35+
## Installations
36+
37+
Clone the project
38+
39+
```bash
40+
41+
```
42+
## Run Project
43+
44+
Go to android studio compile and install dependencies
45+
46+
Run the app on your emulator or device
47+
48+
49+
50+
## Dependencies
51+
52+
- Retrofit/Gson
53+
54+
- Glide
55+
56+
- HILT
57+
58+
- Coroutines
59+
60+
- view binding
61+
62+
- Live Data
63+
64+
## Contributing
65+
66+
Contributions are always welcome!
67+
68+
See [contributing guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md) for ways to get started.
69+
70+
Please adhere to this project's `code of conduct`.
71+
72+
1. Fork it
73+
2. Create your feature branch (git checkout -b my-new-feature)
74+
3. Commit your changes (git commit -m 'Add some feature')
75+
4. Push your branch (git push origin my-new-feature)
76+
5. Create a new Pull Request
77+
78+
## License
79+
80+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)