Skip to content

Commit ead8670

Browse files
authored
Update README.md
1 parent 8315967 commit ead8670

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
useCompose
2-
---
1+
# useCompose
32

4-
React inspired hooks for Compose
3+
Headless @Composable hooks that drive UI logic. Inspired by React.
54

65
[![](https://jitpack.io/v/pavi2410/useCompose.svg)](https://jitpack.io/#pavi2410/useCompose) [![CI](https://github.com/pavi2410/useCompose/actions/workflows/ci.yml/badge.svg)](https://github.com/pavi2410/useCompose/actions/workflows/ci.yml)
76

@@ -13,6 +12,10 @@ React inspired hooks for Compose
1312
- useState
1413
- useEffect
1514
- useContext
15+
- useReducer
16+
17+
### 🪝 hooks
18+
- useToggle
1619

1720
### 🕸 network
1821
- useConnnectionStatus
@@ -23,20 +26,25 @@ Step 1. Add the JitPack repository to your build file
2326

2427
Add it in your root build.gradle at the end of repositories:
2528
```gradle
26-
allprojects {
27-
repositories {
28-
...
29-
maven { url 'https://jitpack.io' }
29+
repositories {
30+
...
31+
maven {
32+
url = uri("https://jitpack.io")
3033
}
3134
}
3235
```
3336

3437
Step 2. Add the dependency
3538
```gradle
3639
dependencies {
37-
implementation 'com.github.pavi2410.useCompose:<module_name>:<version>'
40+
implementation("com.github.pavi2410.useCompose:<module_name>:<version>")
3841
}
3942
```
4043

4144
## Help Wanted
42-
I want your help in making this library extensive such that this covers many of the commonly used hooks. Also, I want your help in building a KMP friendly library.
45+
46+
I want your help in making this library extensive such that this cover many of the commonly used hooks. Also, I want your help in building a KMP friendly library.
47+
48+
## License
49+
50+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)