From 83050b0d3b7f0f07fa23acf5cce93680a374906c Mon Sep 17 00:00:00 2001
From: xuthus5 <xuthus5@gmail.com>
Date: Thu, 22 Jun 2023 01:08:09 +0800
Subject: [PATCH] docs: readme

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 go.mod    |  1 -
 2 files changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index befe695..98afbee 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,36 @@
 - 获取所有的常量定义
 - 获取所有的函数定义
 - 获取所有的结构体定义
-- 获取所有的方法定义
\ No newline at end of file
+- 获取所有的方法定义
+
+## 用例
+
+```go
+package main
+
+import
+gitter.top/coco/goast
+
+func
+func main() {
+    parser, err := NewParser("hello.go")
+    if err != nil {
+        // do something
+    }
+    defines, err := parser.Parse()
+    if err != nil {
+        // do something
+    }
+    // 是否存在变量Hello
+    defines.ExistVariable("Hello")
+    // 是否存在常量 World
+    defines.ExistConstant("World")
+    // 是否存在函数 Add
+    defines.ExistFunction("Add")
+    // 是否存在Calc结构体的方法 Sub
+    defines.ExistMethod("Calc.Sub")
+    // 是否存在导入包 "a/b/c"
+    defines.ExistImport("a/b/c")
+    // 是否存在结构体定义 Calc
+    defines.ExistType("Calc")
+```
\ No newline at end of file
diff --git a/go.mod b/go.mod
index 3489e7a..69746d4 100644
--- a/go.mod
+++ b/go.mod
@@ -7,6 +7,5 @@ require github.com/stretchr/testify v1.8.1
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/stretchr/objx v0.5.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )