From e5338fdc35581499feb2487dfaba7c743bc874a2 Mon Sep 17 00:00:00 2001
From: zuzuviewer <750938164@qq.com>
Date: Sat, 31 Jul 2021 11:45:24 +0800
Subject: [PATCH] Update README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

增加功能描述
---
 README.md | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d2487c0..bffe0d3 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,41 @@
-# openk
+# Openk
 
-json转yaml，yaml转json工具，从指定文件中得到输入，支持将结果输出到标准输出或者指定文件
+json转yaml，yaml转json，输出格式化和字符串格式的json数据工具，从指定文件中得到输入。
+支持将结果输出到标准输出或者指定文件
+
+# Install
+
+go get https://github.com/zuzuviewer/openk
+
+cd openk/cmd
+
+go install openk.go
+
+# Usage
+
+## json转yaml
+
+openk convert -f test.json
+
+openk convert -f test.json -w test.yaml
+
+## yaml转json
+
+openk convert -f test.yaml
+
+openk convert -f test.yml -w test.json
+
+## 输出格式化的json
+
+openk convert -i -f test.json
+
+openk convert -i -f test.json -w t.json
+
+## 输出字符串格式的json
+
+openk convert -s -f test.json
+
+openk convert -s -f test.json -w t.txt
 
 # License