Update README.md

push-protocol · Jul 22, 2023 · bfeee5f · bfeee5f
1 parent 8972cea
commit bfeee5f
Showing 1 changed file with 76 additions and 76 deletions.
diff --git a/packages/restapi/README.md b/packages/restapi/README.md
@@ -12,93 +12,93 @@ This package gives access to Push Protocol (Push Nodes) APIs. Visit [Developer D
   - [About generating the "signer" object for different platforms](#about-generating-the-signer-object-for-different-platforms)
     - [When using in SERVER-SIDE code:](#when-using-in-server-side-code)
     - [When using in FRONT-END code:](#when-using-in-front-end-code)
-  - [**About blockchain agnostic address format**](#about-blockchain-agnostic-address-format)
+  - [About blockchain agnostic address format](#about-blockchain-agnostic-address-format)
     - [Chat blockchain agnostic address format](#chat-blockchain-agnostic-address-format)
-  - [**About Push contract addresses**](#about-push-contract-addresses)
+  - [About Push contract addresses](#about-push-contract-addresses)
     - [Push core contract address](#push-core-contract-address)
     - [Push communicator contract address](#push-communicator-contract-address)
 - [SDK Features](#sdk-features)
   - [For Notification](#for-notification)
-    - [**Fetching user notifications**](#fetching-user-notifications)
-    - [**Fetching user spam notifications**](#fetching-user-spam-notifications)
-    - [**Fetching user subscriptions**](#fetching-user-subscriptions)
-    - [**Fetching channel details**](#fetching-channel-details)
-    - [**Searching for channel(s)**](#searching-for-channels)
-    - [**Opt in to a channel**](#opt-in-to-a-channel)
-    - [**Opt out to a channel**](#opt-out-to-a-channel)
-    - [**Sending notification**](#sending-notification)
-      - [**Direct payload for single recipient(target)**](#direct-payload-for-single-recipienttarget)
-      - [**Direct payload for group of recipients(subset)**](#direct-payload-for-group-of-recipientssubset)
-      - [**Direct payload for all recipients(broadcast)**](#direct-payload-for-all-recipientsbroadcast)
-      - [**IPFS payload for single recipient(target)**](#ipfs-payload-for-single-recipienttarget)
-      - [**IPFS payload for group of recipients(subset)**](#ipfs-payload-for-group-of-recipientssubset)
-      - [**IPFS payload for all recipients(broadcast)**](#ipfs-payload-for-all-recipientsbroadcast)
-      - [**Minimal payload for single recipient(target)**](#minimal-payload-for-single-recipienttarget)
-      - [**Minimal payload for a group of recipient(subset)**](#minimal-payload-for-a-group-of-recipientsubset)
-      - [**Minimal payload for all recipients(broadcast)**](#minimal-payload-for-all-recipientsbroadcast)
-      - [**Graph payload for single recipient(target)**](#graph-payload-for-single-recipienttarget)
-      - [**Graph payload for group of recipients(subset)**](#graph-payload-for-group-of-recipientssubset)
-      - [**Graph payload for all recipients(broadcast)**](#graph-payload-for-all-recipientsbroadcast)
+    - [Fetching user notifications](#fetching-user-notifications)
+    - [Fetching user spam notifications](#fetching-user-spam-notifications)
+    - [Fetching user subscriptions](#fetching-user-subscriptions)
+    - [Fetching channel details](#fetching-channel-details)
+    - [Searching for channel(s)](#searching-for-channels)
+    - [Opt in to a channel](#opt-in-to-a-channel)
+    - [Opt out to a channel](#opt-out-to-a-channel)
+    - [Sending notification](#sending-notification)
+      - [Direct payload for single recipient(target)](#direct-payload-for-single-recipienttarget)
+      - [Direct payload for group of recipients(subset)](#direct-payload-for-group-of-recipientssubset)
+      - [Direct payload for all recipients(broadcast)](#direct-payload-for-all-recipientsbroadcast)
+      - [IPFS payload for single recipient(target)](#ipfs-payload-for-single-recipienttarget)
+      - [IPFS payload for group of recipients(subset)](#ipfs-payload-for-group-of-recipientssubset)
+      - [IPFS payload for all recipients(broadcast)](#ipfs-payload-for-all-recipientsbroadcast)
+      - [Minimal payload for single recipient(target)](#minimal-payload-for-single-recipienttarget)
+      - [Minimal payload for a group of recipient(subset)](#minimal-payload-for-a-group-of-recipientsubset)
+      - [Minimal payload for all recipients(broadcast)](#minimal-payload-for-all-recipientsbroadcast)
+      - [Graph payload for single recipient(target)](#graph-payload-for-single-recipienttarget)
+      - [Graph payload for group of recipients(subset)](#graph-payload-for-group-of-recipientssubset)
+      - [Graph payload for all recipients(broadcast)](#graph-payload-for-all-recipientsbroadcast)
     - [Notification Helper Utils](#notification-helper-utils)
-      - [**Parsing notifications**](#parsing-notifications)
+      - [Parsing notifications](#parsing-notifications)
     - [Advanced Notifications (WIP)](#advanced-notifications-wip)
     - [DEPRECATED](#deprecated)
-      - [**Get a channel's subscriber list of addresses**](#get-a-channels-subscriber-list-of-addresses)
+      - [Get a channel's subscriber list of addresses](#get-a-channels-subscriber-list-of-addresses)
   - [For Chat](#for-chat)
-    - [**Create user for chat**](#create-user-for-chat)
-    - [**Get user data for chat**](#get-user-data-for-chat)
-    - [**Decrypting encrypted pgp private key from user data**](#decrypting-encrypted-pgp-private-key-from-user-data)
-    - [**Updating User Profile**](#updating-user-profile)
-    - [**Fetching list of user chats**](#fetching-list-of-user-chats)
-    - [**Fetching list of user chat requests**](#fetching-list-of-user-chat-requests)
-    - [**Fetching conversation hash between two users**](#fetching-conversation-hash-between-two-users)
-    - [**Fetching latest chat between two users**](#fetching-latest-chat-between-two-users)
-    - [**Fetching chat history between two users**](#fetching-chat-history-between-two-users)
-    - [**To send a message**](#to-send-a-message)
-    - [**To approve a chat request**](#to-approve-a-chat-request)
-    - [**To create a group**](#to-create-a-group)
-    - [**To create a token gated group**](#to-create-a-token-gated-group)
-    - [**To update group details**](#to-update-group-details)
-    - [**To update token gated group details**](#to-update-token-gated-group-details)
-    - [**To get group details by group name**](#to-get-group-details-by-group-name)
-    - [**To get group details by chatId**](#to-get-group-details-by-chatid)
-    - [**Chat Helper Utils**](#chat-helper-utils)
-      - [**Decrypting messages**](#decrypting-messages)
+    - [Create user for chat](#create-user-for-chat)
+    - [Get user data for chat](#get-user-data-for-chat)
+    - [Decrypting encrypted pgp private key from user data](#decrypting-encrypted-pgp-private-key-from-user-data)
+    - [Updating User Profile](#updating-user-profile)
+    - [Fetching list of user chats](#fetching-list-of-user-chats)
+    - [Fetching list of user chat requests](#fetching-list-of-user-chat-requests)
+    - [Fetching conversation hash between two users](#fetching-conversation-hash-between-two-users)
+    - [Fetching latest chat between two users](#fetching-latest-chat-between-two-users)
+    - [Fetching chat history between two users](#fetching-chat-history-between-two-users)
+    - [To send a message](#to-send-a-message)
+    - [To approve a chat request](#to-approve-a-chat-request)
+    - [To create a group](#to-create-a-group)
+    - [To create a token gated group](#to-create-a-token-gated-group)
+    - [To update group details](#to-update-group-details)
+    - [To update token gated group details](#to-update-token-gated-group-details)
+    - [To get group details by group name](#to-get-group-details-by-group-name)
+    - [To get group details by chatId](#to-get-group-details-by-chatid)
+    - [Chat Helper Utils](#chat-helper-utils)
+      - [Decrypting messages](#decrypting-messages)
   - [For Video](#for-video)
-    - [**Instance Variables**](#instance-variables)
-      - [**peerInstance**](#peerinstance)
-      - [**signer**](#signer)
-      - [**chainId**](#chainid)
-      - [**pgpPrivateKey**](#pgpprivatekey)
-      - [**env**](#env)
-    - [**data**](#data)
-      - [**setData**](#setdata)
-    - [**Methods**](#methods)
-      - [**constructor**](#constructor)
-      - [**create**](#create)
-      - [**request**](#request)
-      - [**acceptRequest**](#acceptrequest)
-      - [**connect**](#connect)
-      - [**disconnect**](#disconnect)
-      - [**enableVideo**](#enablevideo)
-      - [**enableAudio**](#enableaudio)
-      - [**isInitiator**](#isinitiator)
+    - [Instance Variables](#instance-variables)
+      - [peerInstance](#peerinstance)
+      - [signer](#signer)
+      - [chainId](#chainid)
+      - [pgpPrivateKey](#pgpprivatekey)
+      - [env](#env)
+    - [data](#data)
+      - [setData](#setdata)
+    - [Methods](#methods)
+      - [constructor](#constructor)
+      - [create](#create)
+      - [request](#request)
+      - [acceptRequest](#acceptrequest)
+      - [connect](#connect)
+      - [disconnect](#disconnect)
+      - [enableVideo](#enablevideo)
+      - [enableAudio](#enableaudio)
+      - [isInitiator](#isinitiator)
   - [For Spaces](#for-spaces)
-    - [**To create a space**](#to-create-a-space)
-    - [**To create a token gated space**](#to-create-a-token-gated-space)
-    - [**To update space details**](#to-update-space-details)
-    - [**To update token gated space details**](#to-update-token-gated-space-details)
-    - [**To get space details by spaceId**](#to-get-space-details-by-spaceid)
-    - [**To start a space**](#to-start-a-space)
-    - [**To stop a space**](#to-stop-a-space)
-    - [**To approve a space request**](#to-approve-a-space-request)
-    - [**To add listeners to space**](#to-add-listeners-to-space)
-    - [**To remove listeners from space**](#to-remove-listeners-from-space)
-    - [**To add speakers to space**](#to-add-speakers-to-space)
-    - [**To remove speakers from space**](#to-remove-speakers-from-space)
-    - [**Fetching list of user spaces**](#fetching-list-of-user-spaces)
-    - [**Fetching list of user space requests**](#fetching-list-of-user-space-requests)
-    - [**Fetching list of trending spaces**](#fetching-list-of-trending-spaces)
+    - [To create a space](#to-create-a-space)
+    - [To create a token gated space](#to-create-a-token-gated-space)
+    - [To update space details](#to-update-space-details)
+    - [To update token gated space details](#to-update-token-gated-space-details)
+    - [To get space details by spaceId](#to-get-space-details-by-spaceid)
+    - [To start a space](#to-start-a-space)
+    - [To stop a space](#to-stop-a-space)
+    - [To approve a space request](#to-approve-a-space-request)
+    - [To add listeners to space](#to-add-listeners-to-space)
+    - [To remove listeners from space](#to-remove-listeners-from-space)
+    - [To add speakers to space](#to-add-speakers-to-space)
+    - [To remove speakers from space](#to-remove-speakers-from-space)
+    - [Fetching list of user spaces](#fetching-list-of-user-spaces)
+    - [Fetching list of user space requests](#fetching-list-of-user-space-requests)
+    - [Fetching list of trending spaces](#fetching-list-of-trending-spaces)
 
 # How to use in your app?