From 8b979a653d083d44a6c529090973228a15bc5ae2 Mon Sep 17 00:00:00 2001
From: xuthus5 <xuthus5@gmail.com>
Date: Tue, 19 Mar 2024 22:53:48 +0800
Subject: [PATCH] chore: readme docs

---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..045d53d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# protofmt
+
+修改自 [https://github.com/emicklei/proto-contrib](https://github.com/emicklei/proto-contrib)
+
+## 使用
+
+```go
+package main
+
+import (
+	"bytes"
+	"os"
+
+	"github.com/emicklei/proto"
+	"gitter.top/common/protofmt"
+)
+
+func main()  {
+	def, err := os.ReadFile("testdata.proto")
+	if err != nil {
+		// do something
+    }
+	parser := proto.NewParser(bytes.NewReader(def))
+	parse, err := parser.Parse()
+	if err != nil {
+		// do something
+	}
+	var buf = new(bytes.Buffer)
+	protofmt.NewFormatter(buf, "    ").Format(parse)
+	err = os.WriteFile("testdata.proto", buf.Bytes(), os.ModePerm)
+	if err != nil {
+		// do something
+	}
+}
+
+```
\ No newline at end of file