Skip to content

Commit 2ab38f9

Browse files
authored
Update README.md
1 parent d8b9fa6 commit 2ab38f9

File tree

1 file changed

+78
-14
lines changed

1 file changed

+78
-14
lines changed

README.md

Lines changed: 78 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
<p align="center">
22
<a href=""><img width="200" height="200" src="https://github.com/w2sv/WiFi-Widget/blob/main/app/src/main/res/mipmap-xxxhdpi/logo_round.png" alt=""></a>
33
</p>
4-
<h1 align="center">WiFi Widget</h1>
4+
5+
<div id="user-content-toc">
6+
<ul style="list-style: none; padding-left: 0;">
7+
<summary>
8+
<div align="center">
9+
<h1>WiFi Widget</h1>
10+
</div>
11+
</summary>
12+
</ul>
13+
</div>
514

615
<p align="center">
7-
<img src="https://img.shields.io/endpoint?color=green&logo=google-play&logoColor=green&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Dcom.w2sv.wifiwidget%26l%3DPlay%2520Store%26m%3D%24version" alt=""/>
16+
<img src="https://img.shields.io/endpoint?color=green&logo=google-play&logoColor=green&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Dcom.w2sv.wifiwidget%26l%3DPlay%2520Store%26m%3D%24version"/>
817
<img alt="F-Droid" src="https://img.shields.io/f-droid/v/com.w2sv.wifiwidget">
18+
<img src="https://img.shields.io/f-droid/v/com.w2sv.wifiwidget?baseUrl=https://apt.izzysoft.de/fdroid&label=IzzyOnDroid">
919
<img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/w2sv/WiFi-Widget?include_prereleases"/>
1020

1121
<br>
@@ -31,21 +41,36 @@
3141

3242
------
3343

34-
<h2 align="center">Screenshots</h2>
35-
3644
| ![](https://github.com/w2sv/WiFi-Widget/blob/main/app/src/main/play/listings/en-US/graphics/phone-screenshots/1.jpg) | ![](https://github.com/w2sv/WiFi-Widget/blob/main/app/src/main/play/listings/en-US/graphics/phone-screenshots/2.jpg) | ![](https://github.com/w2sv/WiFi-Widget/blob/main/app/src/main/play/listings/en-US/graphics/phone-screenshots/3.jpg) |
3745
|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
3846
| ![](https://github.com/w2sv/WiFi-Widget/blob/main/app/src/main/play/listings/en-US/graphics/phone-screenshots/4.jpg) | ![](https://github.com/w2sv/WiFi-Widget/blob/main/app/src/main/play/listings/en-US/graphics/phone-screenshots/5.jpg) | ![](https://github.com/w2sv/WiFi-Widget/blob/main/app/src/main/play/listings/en-US/graphics/phone-screenshots/6.jpg) |
3947

40-
<h2 align="center">Download</h2>
48+
<div id="user-content-toc">
49+
<ul style="list-style: none; padding-left: 0;">
50+
<summary>
51+
<div align="center">
52+
<h1>Where to get it</h1>
53+
</div>
54+
</summary>
55+
</ul>
56+
</div>
4157

4258
<p align="center">
4359
<a href="https://play.google.com/store/apps/details?id=com.w2sv.wifiwidget"><img alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="80"/></a>
4460
<a href="https://f-droid.org/packages/com.w2sv.wifiwidget/"><img alt="Download from F-Droid" src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="80"/></a>
61+
<a href="https://apt.izzysoft.de/packages/com.w2sv.wifiwidget"><img alt="Download from IzzyOnDroid" src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" height="80"/></a>
4562
<a href="https://github.com/w2sv/WiFi-Widget/releases/latest"><img alt="Get it on GitHub" src="https://github.com/machiav3lli/oandbackupx/blob/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png" height="80"/></a>
4663
</p>
4764

48-
<h2 align="center">Features</h2>
65+
<div id="user-content-toc">
66+
<ul style="list-style: none; padding-left: 0;">
67+
<summary>
68+
<div align="center">
69+
<h1>Features</h1>
70+
</div>
71+
</summary>
72+
</ul>
73+
</div>
4974

5075
### In-App
5176

@@ -86,7 +111,15 @@
86111
- Interval: between 15 min and 24h
87112
- Whether to refresh on low battery
88113

89-
<h2 align="center">Tech Stack</h2>
114+
<div id="user-content-toc">
115+
<ul style="list-style: none; padding-left: 0;">
116+
<summary>
117+
<div align="center">
118+
<h1>Tech Stack</h1>
119+
</div>
120+
</summary>
121+
</ul>
122+
</div>
90123

91124
- Kotlin only
92125
- Jetpack Compose for in-app UI, xml & RemoteViews for widget UI
@@ -99,18 +132,33 @@
99132
- JUnit 4 Compose android (instrumented) testing
100133
- Androidx Macro benchmarking & baseline profile generation with app-specific usage journey, implemented with [UI Automator](https://developer.android.com/training/testing/other-components/ui-automator)
101134

102-
<h2 align="center">Architecture</h2>
135+
<div id="user-content-toc">
136+
<ul style="list-style: none; padding-left: 0;">
137+
<summary>
138+
<div align="center">
139+
<h1>Architecture</h1>
140+
</div>
141+
</summary>
142+
</ul>
143+
</div>
103144

104145
- **Multi-modular build**
105146
- **Gradle Convention plugins** for gradle code reuse whilst keeping modules independent from one another
106-
- **Clean architecture** (or however you wanna call it), with the UI and data layers depending on the domain layer, which exposes the data model and repository interfaces
147+
- **Clean architecture** (or however you wanna call it), with the UI and data layers depending on the domain layer, which exposes the data model and repository interfaces:
107148

108-
<h3 align="center">Module Dependency Graph</h2>
109149
<p align="center">
110150
<img src="docs/graphs/dependency_graph.svg" alt=""/>
111151
</p>
112152

113-
<h2 align="center">Credits</h2>
153+
<div id="user-content-toc">
154+
<ul style="list-style: none; padding-left: 0;">
155+
<summary>
156+
<div align="center">
157+
<h1>Credits</h1>
158+
</div>
159+
</summary>
160+
</ul>
161+
</div>
114162

115163
<p align="center">
116164
Logo foreground by <a href="https://freeicons.io/profile/75801">Hilmy Abiyyu Asad</a> taken
@@ -119,13 +167,29 @@ where it is licensed
119167
under <a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons(Attribution 3.0 unported)</a>.
120168
</p>
121169

122-
<h2 align="center">Donations</h2>
123-
<br>
170+
<div id="user-content-toc">
171+
<ul style="list-style: none; padding-left: 0;">
172+
<summary>
173+
<div align="center">
174+
<h1>Donations</h1>
175+
</div>
176+
</summary>
177+
</ul>
178+
</div>
179+
124180
<p align="center">
125181
<a href="https://www.buymeacoffee.com/w2sv" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important" ></a>
126182
</p>
127183

128-
<h2 align="center">License</h2>
184+
<div id="user-content-toc">
185+
<ul style="list-style: none; padding-left: 0;">
186+
<summary>
187+
<div align="center">
188+
<h1>License</h1>
189+
</div>
190+
</summary>
191+
</ul>
192+
</div>
129193

130194
<p align="center">
131195
<a href="https://github.com/w2sv/WiFi-Widget/blob/main/LICENSE">GPL-3.0 License</a> © <a href="https://github.com/w2sv">w2sv</a> [2022 - Present]

0 commit comments

Comments
 (0)