Friend request

docusaurus/docs/howto/friendship.md → docusaurus/docs/howto/friendship.mdx

@@ -1,11 +1,32 @@
 ---
-title: 'Making friends'
+title: 'Send and accept friend requests'
 ---
 
 import Tabs from '@theme/Tabs'
 import TabItem from '@theme/TabItem'
 
-## Sending Request
+Sending and accepting friend requests can easily be done using wechaty `onfriendship` function. This guide will help you send request, receive request(in friend event), confirm friendship(friend event) in a room.
+
+Use the guide to help you integrate additional functions to an existing project which is present at [Github/Friend-Bot](https://github.com/wechaty/wechaty/blob/1523c5e02be46ebe2cc172a744b2fbe53351540e/examples/friend-bot.ts) or check that your existing local system will run on Wechaty. If, you wish to learn on how to build the bot on your own, please visit one of our [Building the bot](https://wechaty.js.org/docs/examples/basic/contact-bot#building-the-bot) section.
+
+The steps outlined here mainly focuses on working with Javascript, but user are free to switch between any languages.This guide help you Send, receive friend request, and friend confirmation events.
+
+## Prerequisites
+
+* Your system must have [Node.js](https://nodejs.org/en/download/package-manager/) installed (version >= 12).
+* Your system must have [Wechaty](https://github.com/wechaty/wechaty) (version >= 0.40).
+* You need to be familiar with the basics of Wechaty platform. If not, follow our [tutorials](https://wechaty.js.org/docs/tutorials/) section.
+* You need to have at least a minimal application ready to work, follow one of our [Example/Friend-Bot](https://wechaty.js.org/docs/examples/advanced/friend-bot/).
+
+### If you don't know where to start from
+
+See [Running our first ding-dong bot](https://wechaty.js.org/docs/getting-started/quick-start).
+
+The below function needs a basic script that can help run the bot. The basic script starts by importing the code from [Github/Friend-Bot](https://github.com/wechaty/wechaty/blob/1523c5e02be46ebe2cc172a744b2fbe53351540e/examples/friend-bot.ts).Integrate the below code, for this action to work.
+
+## Send Request - define how to send a friend request
+
+When you send the request, you try to make new friend connection. This section elaborates on how to send friend requests.`Friendship.search(<id>)` helps you search the contact, if found we get "Sending friend request..." as a response else "Friendship.search: not found" as a response.
 
 <Tabs
   groupId="programming-languages"
@@ -119,7 +140,9 @@ class MyBot(Wechaty):
 </TabItem>
 </Tabs>
 
-## Receiving Request
+## Receive Request - define how to accept the friend request
+
+When someone sends you the request, you choose whether to have the friend connection or to reject the connection. This section elaborates on how to accept friend requests. When someone sends you the request, the `friendship.contact()` helps you list down all the contacts with a hello message from `friendship.hello()` and then when the user accepts the request, it prints out with a confirmation message using `friendship.contact().name()`.
 
 <Tabs
   groupId="programming-languages"
@@ -140,11 +163,11 @@ class MyBot(Wechaty):
 <TabItem value="ts">
 
 ```ts
-import { Friendship } from 'wechaty'
+const { Friendship } = require('wechaty')
 
 async function onFriendship (friendship: Friendship) {
   if (friendship.type() === Friendship.Type.Receive) {
-    console.info('New requrest from', friendship.contact())
+    console.info('New request from', friendship.contact())
     console.info('Hello message:', friendship.hello())
     await friendship.accept()
   } else if (friendship.type() === Friendship.Type.Confirm) {
@@ -159,11 +182,11 @@ bot.on('friendship', onFriendship)
 <TabItem value="js">
 
 ```js
-import { Friendship } from 'wechaty'
+const { Friendship } = require('wechaty')
 
 async function onFriendship (friendship) {
   if (friendship.type() === Friendship.Type.Receive) {
-    console.info('New requrest from', friendship.contact())
+    console.info('New request from', friendship.contact())
     console.info('Hello message:', friendship.hello())
     await friendship.accept()
   } else if (friendship.type() === Friendship.Type.Confirm) {

docusaurus/docs/howto/overview.mdx

@@ -15,7 +15,7 @@ These are some use cases and code snippets to get you started with Redux in a re
 - [Dealing with messages](howto/message.md)
 - [Managing contacts](howto/contact.md)
 - [Managing rooms](howto/room.md)
-- [Making friends](howto/friendship.md)
+- [Making friends](howto/friendship.mdx)
 - [Processing files](howto/file-box.md)
 
 ## Using Puppets with Wechaty (How to switch between puppets)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wechaty.js.org",
-  "version": "0.8.328",
+  "version": "0.8.331",
   "description": "Wechaty Official Website for News, Blogs, Contributor Profiles, and Documentations",
   "private": true,
   "directories": {