From abb90789aad95222bbb3fcb820c3e04dc589c9d8 Mon Sep 17 00:00:00 2001
From: Ivy1996-encode <2682904957@qq.com>
Date: Sat, 20 Feb 2021 14:16:19 +0800
Subject: [PATCH] update readme.md

---
 README.md | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 126 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index d690cc6..e0ab32b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
 # openwechat
-golang版个人微信号API
-
-
+> golang版个人微信号API, 类似开发公众号一样，开发个人微信号
 
 
 
@@ -13,15 +11,136 @@ golang版个人微信号API
 
 
 
-### 快速开始
+### 安装
 
-#### 登录微信
-
-```golang
+`go get`
 
+```shell
+go get github.com/Ivy1996-encode/openwechat
 ```
 
 
 
+`go mod`
+
+```shell
+require github.com/Ivy1996-encode/openwechat
+```
+
+
+
+### 快速开始
+
+#### 登录微信
+
+```go
+package main
+
+import (
+	"fmt"
+	"github.com/Ivy1996-encode/openwechat"
+)
+
+func main() {
+	messageHandler := func(msg *openwechat.Message) {
+		fmt.Println(msg)
+	}
+	bot := openwechat.DefaultBot()
+    
+    // 注册消息处理函数
+	bot.RegisterMessageHandler(messageHandler)
+    // 设置默认的登录回调
+    // 可以设置通过该uuid获取到登录的二维码
+	bot.UUIDCallback = openwechat.PrintlnQrcodeUrl
+    // 登录
+	if err := bot.Login(); err != nil {
+		fmt.Println(err)
+		return
+	}
+    // 阻塞主程序,直到用户退出或发生异常
+	bot.Block()
+}
+```
+
+
+
+#### 回复消息
+
+```go
+messageHandler := func(msg *openwechat.Message) {
+		msg.ReplyText("hello")
+}
+```
+
+
+
+#### 获取消息的发送者
+
+```go
+messageHandler := func(msg *openwechat.Message) {
+		sender, err := msg.Sender()
+}
+```
+
+
+
+#### 获取所有的好友
+
+```go
+// 登录之后调用
+self, err := bot.GetCurrentUser()
+if err != nil {
+    fmt.Println(err)
+    return
+}
+friends, err := self.Friends()
+```
+
+
+
+#### 发送消息给好友
+
+```go
+self, err := bot.GetCurrentUser()
+if err != nil {
+    fmt.Println(err)
+    return
+}
+friends, err := self.Friends()
+if err != nil {
+    fmt.Println(err)
+    return
+}
+if friends.Count() > 0 {
+    // 发送给第一个好友
+    friends[0].SendText("你好")
+}
+```
+
+
+
+#### 发送图片消息
+
+```go
+friends, err := self.Friends()
+if err != nil {
+    fmt.Println(err)
+    return
+}
+if friends.Count() > 0 {
+    // 发送给第一个好友
+    img, _ := os.Open("test.png")
+    defer img.Close()
+    friends[0].SendImage(img)
+}
+bot.Block()
+```
+
+
+
+更多功能请在代码中探索。。。
+
+// todo support more
+