Skip to content

Commit 028b01d

Browse files
authored
Update readme.md
Update readme.md.
1 parent d29a01a commit 028b01d

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

README.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
1-
# GitHoob
1+
![cover_small](https://user-images.githubusercontent.com/14924296/189586322-7a521867-3567-4ab4-99e2-073ef1384bdf.png)
22

3-
![githooh](https://user-images.githubusercontent.com/14924296/156920145-94af0bf4-7ed0-402d-9381-76e860eef321.png)
3+
## GitHoob
44

5-
Githoob is alternative android client of @GitHub.
5+
Githoob is alternative android client of [GitHub](https://www.github.com).
66

7+
GitHoob works by [GitHub Api](https://docs.github.com/en/rest) and login with [GitHub OAuth](https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps).
78

8-
# License
9+
## Architecture
10+
11+
The architecture is built around [Android Architecture Components](https://developer.android.com/topic/libraries/architecture/) and follows the recommendations laid out in the [Guide to App Architecture](https://developer.android.com/jetpack/docs/guide). Logic is kept away from Activities and Fragments and moved to [ViewModels](https://developer.android.com/topic/libraries/architecture/viewmodel). Data is observed using [Kotlin Flows](https://developer.android.com/kotlin/flow/stateflow-and-sharedflow) and the [Data Binding Library](https://developer.android.com/topic/libraries/data-binding/) binds UI components in layouts to the app's data sources.
12+
The [Navigation component](https://developer.android.com/guide/navigation) is used to implement navigation in the app, handling Fragment transactions and providing a consistent user experience.
13+
14+
<!-- 1. i most create Architect graph with image and desc -->
15+
16+
## Features
17+
18+
- [x] login with github [OAuth](https://docs.github.com/en/developers/apps/building-oauth-apps/authorizing-oauth-apps)
19+
- [x] handle github link with [deeplink](https://developer.android.com/training/app-links)
20+
- [x] show all details of user profile, repository, connections and etc.
21+
- [ ] add unit, integration and E2E test.
22+
- [ ] edit profile
23+
- [ ] add, edit and delete repository
24+
- [ ] set app online-first in v3.0.
25+
- [ ] replce xml with [jetpack compose](https://developer.android.com/jetpack/compose)
26+
27+
<!-- ### MAD Score -->
28+
29+
## Contributions
30+
31+
If you've found an error in the project, please file an issue.
32+
33+
Patches are encouraged and may be submitted by forking this project and submitting a pull request. Since this project is still in its very early stages, if your change is substantial, please raise an issue first to discuss it.
34+
35+
36+
### License
937

1038
MIT License
1139

0 commit comments

Comments
 (0)