From ca95ddaf8a4295d3f84ce07608f88f3f0aef70ae Mon Sep 17 00:00:00 2001 From: coreyphillips Date: Thu, 3 Oct 2024 20:03:49 -0400 Subject: [PATCH] docs: update readme.md --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 06a9e3a..c938a73 100644 --- a/README.md +++ b/README.md @@ -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