@synonymdev/react-native-pubky 0.8.0 → 0.9.1

package/README.md

@@ -1,6 +1,6 @@
 # react-native-pubky
 
-React Native implementation of [pubky](https://github.com/pubky/pubky)
+React Native implementation of [pubky-core](https://github.com/pubky/pubky-core)
 
 ## Installation
 
@@ -18,20 +18,17 @@ npm install @synonymdev/react-native-pubky
 - [x] [resolveHttps](#resolveHttps): Resolve HTTPS records.
 - [x] [signUp](#signUp): Sign-up to a homeserver and update Pkarr accordingly.
 - [x] [signIn](#signIn): Sign-in to a homeserver.
+- [x] [session](#session): Check the current session for a given Pubky in its homeserver.
 - [x] [signOut](#signOut): Sign-out from a homeserver.
 - [x] [put](#put): Upload a small payload to a given path.
 - [x] [get](#get): Download a small payload from a given path relative to a pubky author.
 - [x] [list](#list): Returns a list of Pubky URLs of the files in the path of the `url` provided.
+- [x] [delete](#delete): Delete a file at a path relative to a pubky author.
 - [x] [generateSecretKey](#generateSecretKey): Generate a secret key.
 - [x] [getPublicKeyFromSecretKey](#getPublicKeyFromSecretKey): Get the public key string and uri from a secret key.
 - [x] [create_recovery_file](#createRecoveryFile): Create a recovery file.
 - [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.
-
-
 ## Usage
 ### <a name="auth"></a>Auth
 ```js
@@ -161,6 +158,20 @@ if (listRes.isErr()) {
 console.log(listRes.value);
 ```
 
+### <a name="deleteFile"></a>deleteFile
+```js
+import { deleteFile } from '@synonymdev/react-native-pubky';
+
+const deleteFileRes = await deleteFile(
+  'pubky://z4e8s17cou9qmuwen8p1556jzhf1wktmzo6ijsfnri9c4hnrdfty/pub/' // URL
+);
+if (deleteFileRes.isErr()) {
+  console.log(deleteFileRes.error.message);
+  return;
+}
+console.log(deleteFileRes.value);
+```
+
 ### <a name="generateSecretKey"></a>generateSecretKey
 ```js
 import { generateSecretKey } from '@synonymdev/react-native-pubky';
@@ -214,6 +225,20 @@ if (signInRes.isErr()) {
 console.log(signInRes.value);
 ```
 
+### <a name="session"></a>sessionRes
+```js
+import { session } from '@synonymdev/react-native-pubky';
+
+const sessionRes = await session(
+  'z4e8s17cou9qmuwen8p1556jzhf1wktmzo6ijsfnri9c4hnrdfty' // Public Key
+);
+if (sessionRes.isErr()) {
+  console.log(sessionRes.error.message);
+  return;
+}
+console.log(sessionRes.value);
+```
+
 ### <a name="signOut"></a>signIn
 ```js
 import { signOut } from '@synonymdev/react-native-pubky';
@@ -270,12 +295,30 @@ git clone git@github.com:pubky/react-native-pubky.git && cd react-native-pubky &
 yarn add path/to/react-native-pubky
 ```
 
-## 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
+```
+
+## Download Remote Bindings
+
+This command will download the current bindings from the [SDK repo](https://github.com/pubky/pubky-core-mobile-sdk):
+
+```sh
+npm run update-remote-bindings
+```
+
+## Setup Local Bindings
 
-After making changes to any of the Rust files, the bindings will need to be updated. To do this, run the following command:
+This command will download the entire Rust project if it doesn't exist and set up the bindings locally for faster iteration and testing:
 
 ```sh
-npm run update-bindings
+npm run update-local-bindings
 ```
 
 Finally, ensure that `PubkyModule.kt`, `Pubky.swift`, `Pubky.mm` & `src/index.tsx` are updated accordingly based on the changes made to the Rust files.