Skip to content

Commit

Permalink
docs: update readme (#19)
Browse files Browse the repository at this point in the history
Co-authored-by: olliiiver <[email protected]>
Co-authored-by: Johannes Marbach <[email protected]>
  • Loading branch information
3 people authored Dec 20, 2024
1 parent 162f153 commit 63d91c3
Showing 1 changed file with 2 additions and 16 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,15 @@ Powered by [uniffi-bindgen-react-native] and [create-react-native-library].

## Installation

### Installation into your own project

This package is available in the [npm registry].

```sh
npm i @unomed/react-native-matrix-sdk
yarn add @unomed/react-native-matrix-sdk
```

You also have to install [uniffi-bindgen-react-native]. This will only be necessary until its
Pod has been released. Make sure that the SHA matches the release of react-native-matrix-sdk.

```sh
npm add https://github.com/jhugman/uniffi-bindgen-react-native#$sha
yarn add uniffi-bindgen-react-native@https://github.com/jhugman/uniffi-bindgen-react-native#$sha
```

Afterwards add the Pod and run `pod install`.

```
target 'MyAwesomeApp' do
pod 'uniffi-bindgen-react-native', :path => '../node_modules/uniffi-bindgen-react-native'
...
end
```

### Installation from local checkout

Expand Down

0 comments on commit 63d91c3

Please sign in to comment.