From ddd75f7edbf1dce4426616ebbe41eca281e8c258 Mon Sep 17 00:00:00 2001
From: xujie <xujie@yijiahe.com>
Date: Fri, 13 Oct 2023 11:30:52 +0800
Subject: [PATCH] add README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e8f92c1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+Jetpack Compose - Scribble Indicator
+---
+
+my maven library project
+
+<p align="center">
+  <a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
+  <a href="https://android-arsenal.com/api?level=24"><img alt="API" src="https://img.shields.io/badge/API-24%2B-brightgreen.svg?style=flat"/></a>
+  <a href="https://github.com/xuie0000"><img alt="Author" src="https://img.shields.io/badge/Author-XuJie-red.svg?style=flat"/></a>
+  <a href="https://github.com/xuie0000/ScribbleIndicator"><img alt="Profile" src="https://img.shields.io/github/v/release/xuie0000/ScribbleIndicator.svg"/></a> 
+</p>
+
+## Download
+
+lib is available on `mavenCentral()`.
+
+```groovy
+implementation("com.xuie0000:scribble-indicator:1.0.0")
+```
+
+## Usage
+
+```groovy
+val pagerState: PagerState = rememberPagerState { list.size }
+
+ScribbleIndicator(
+    list = list,
+    modifier = Modifier,
+    pagerState = pagerState,
+    title = {
+    },
+    content = {
+    },
+)
+```