docs: update readme.md

This commit is contained in:
coreyphillips
2024-10-03 20:03:49 -04:00
parent e315617f96
commit ca95ddaf8a

View File

@@ -28,8 +28,8 @@ npm install @synonymdev/react-native-pubky
- [x] [decrypt_recovery_file](#decryptRecoveryFile): Decrypt a recovery file.
### Methods to be Implemented
- [ ] getProfile: Retrieve the profile of a user.
- [ ] editProfile: Submit changes to the specified profile.
- [ ] session: Check the current session for a given Pubky in its homeserver.
- [ ] delete: Delete a file at a path relative to a pubky author.
## Usage
@@ -278,6 +278,16 @@ After making changes to any of the Rust files, the bindings will need to be upda
npm run update-bindings
```
## Run React Native Example App
1. Run Homeserver:
```sh
cd rust/pubky/pubky-homeserver && cargo run -- --config=./src/config.toml
```
2. Run the React Native Example App:
```sh
cd example && yarn install && cd ios && pod install && cd ../ && yarn ios
```
Finally, ensure that `PubkyModule.kt`, `Pubky.swift`, `Pubky.mm` & `src/index.tsx` are updated accordingly based on the changes made to the Rust files.
## License