11# ScreenNameViewer-For-Compose
2+ [ ![ Hits] ( https://myhits.vercel.app/api/hit/https%3A%2F%2Fgithub.com%2FDongLab-DevTools%2FScreenNameViewer-For-Compose%3Ftab%3Dreadme-ov-file?color=blue&label=hits&size=small )] ( https://myhits.vercel.app )
3+ [ ![ Platform] ( https://img.shields.io/badge/platform-Android-3DDC84?style=flat-square&logo=android )] ( https://developer.android.com )
4+ [ ![ Min SDK] ( https://img.shields.io/badge/min%20sdk-21-green?style=flat-square )] ( https://developer.android.com )
5+
26
37** [ 한국어 README] ( ./README_ko.md ) **
48
59## Overview
610
711![ sample] ( https://github.com/DongLab-DevTools/ScreenNameViewer-For-Compose/blob/eae99cecc086002a6958e12620ec80647c89822f/.github/docs/images/screennameviewer-compose-exmaple.png )
812
13+ <a href =" https://github.com/DongLab-DevTools/ScreenNameViewer " >
14+ <img src="https://github.com/DongLab-DevTools/ScreenNameViewer-For-Compose/blob/9c53027addec40826ed428567965cfc46d17149f/.github/docs/images/screen_name_viewer_link_thumb_xml_en.png"/>
15+ </a >
16+
17+ <br >
18+ <br >
19+
920ScreenNameViewer is a debugging tool that overlays the class name of the currently displayed screen.
1021It allows you to intuitively check which screen is active, and in a Compose environment, it can also display the screen route.
1122
1223This allows you to quickly find and navigate to the code for the desired screen, improving both debugging and development efficiency.
1324
25+ <br >
26+
1427## Features
1528
1629- ** Real-time class name display** : Shows Activity and Fragment class names on screen in real-time
@@ -20,6 +33,8 @@ This allows you to quickly find and navigate to the code for the desired screen,
2033- ** Memory safe** : Prevents memory leaks using WeakReference
2134- ** Touch interaction** : Touch overlay to show full class name in toast
2235
36+ <br >
37+
2338## Installation
2439
2540### Step 1: Add GitHub Packages repository
@@ -65,9 +80,13 @@ github_token=YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
6580> [ !NOTE]
6681> You need a GitHub Personal Access Token with ` read:packages ` permission to download from GitHub Packages.
6782
83+ <br >
84+
6885### Requirements
6986- Android API 21 (Android 5.0) or higher
7087
88+ <br >
89+
7190## Usage
7291
7392### Initialize in Application class
@@ -117,6 +136,8 @@ class MyApplication : Application() {
117136 }
118137```
119138
139+ <br >
140+
120141## Configuration
121142
122143### DSL Configuration
@@ -151,6 +172,8 @@ initScreenNameViewer(this) {
151172}
152173```
153174
175+ <br >
176+
154177### Configuration Options
155178
156179- ** settings** : Configure activation conditions
@@ -162,6 +185,8 @@ initScreenNameViewer(this) {
162185 - ` background ` : Background color and padding
163186 - ` position ` : Margin and display positions for different components
164187
188+ <br >
189+
165190## Contributors
166191
167192<!-- readme: collaborators,contributors -start -->
0 commit comments