Skip to content

Commit

Permalink
feat(library setup): updating readme2
Browse files Browse the repository at this point in the history
  • Loading branch information
ssathy2 committed Jul 3, 2024
1 parent eb92bf2 commit 2404328
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,21 @@ import { ConnectButton } from 'connectsdk-reactnative';
/>
```

## Running locally
In order to see an example of the wrapper, you'll need the following dependencies:
- yarn
- npm
- Cocoapods

1. Clone the repository
2. Run `yarn` to setup yarn dependencies
3. Go to `example/ios` folder
4. Run `pod install` to setup Cocoapods for the example project.
5. Go back to root of the repository.
6. Run `yarn example ios` to run the iOS app.

To see usage of the ConnectButton in Typescript, go to `example/src/App.tsx`.

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
Expand Down

0 comments on commit 2404328

Please sign in to comment.