Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pavi2410 authored Dec 23, 2021
1 parent bce9dbd commit 292b294
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,21 @@ useCompose

React inspired hooks for Compose

[![](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)

![carbon](https://user-images.githubusercontent.com/28837746/146000979-428e294d-425c-448b-a5e4-66110ab81100.png)

### Installation
## Modules

### ⚛ react
- useState
- useEffect
- useContext

### 🕸 network
- useConnnectionStatus

## Installation

Step 1. Add the JitPack repository to your build file

Expand All @@ -22,9 +34,9 @@ allprojects {
Step 2. Add the dependency
```gradle
dependencies {
implementation 'com.github.pavi2410:useCompose:1.0.0'
implementation 'com.github.pavi2410.useCompose:<module_name>:<version>'
}
```

### Help Wanted
## Help Wanted
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.

0 comments on commit 292b294

Please sign in to comment.