From 384cf8de97f5760ced6d1b2d4d6fc239e847720b Mon Sep 17 00:00:00 2001
From: lvsi <15239928381@163.com>
Date: Thu, 15 Sep 2022 21:37:35 +0800
Subject: [PATCH] =?UTF-8?q?doc:=20=E6=96=87=E6=A1=A3=E6=B7=BB=E5=8A=A0?=
=?UTF-8?q?=E7=9B=AE=E5=BD=95=E7=B4=A2=E5=BC=95?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 47 +++++++++++++++++++++++++++++++++--------------
1 file changed, 33 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index c8a1f94..7b3ba16 100644
--- a/README.md
+++ b/README.md
@@ -14,12 +14,31 @@
-# 一、项目介绍
+
+ 目录
+
+- [一、项目介绍](#1)
+- [二、快速安装](#2)
+- [三、如何使用](#3)
+- [1、调整代码格式](#31)
+- [2、设置全局钩子](#32)
+- [(1) checkout钩子](#321)
+- [(2) pull钩子](#322)
+- [(3) commit钩子](#323)
+- [(4) push钩子](#324)
+- [四、卸载更新](#4)
+- [1、卸载应用](#41)
+- [2、版本更新](#42)
+- [五、项目贡献](#5)
+
+
+
+# 一、项目介绍
posture是一个轻量可扩展的开发姿势监督与矫正工具，让您快速开始以正确的规范编写和管理代码，解决团队开发时代码百花齐放、Git误操作等一系列开发中的"姿势不正确"问题。
> 关于更多背景细节请阅读文章[《以正确的姿势编写和管理代码》](https://github.com/WGrape/Blog/issues/260)
-# 二、快速安装
+# 二、快速安装
您可以先通过以下命令完成下载安装操作，如果出现```install successfully```提示，则说明安装成功。
@@ -37,33 +56,33 @@ export POSTUREPATH={{the path of posture installation}}
export PATH=$PATH:${POSTUREPATH}
```
-# 三、如何使用
+# 三、如何使用
-## 1、调整代码格式
+## 1、调整代码格式
在团队开发前，需要先统一调整代码规范。工具支持```go/php/java```三种语言的代码规范设置，在```config/config.sh```文件中配置```lang```项目语言，然后切至您的项目目录下，再使用如下命令即可。
```bash
posture adjust
```
-## 2、设置全局钩子
+## 2、设置全局钩子
通过如下命令即可设置全局钩子，这样无论在哪个项目下，在使用```git checkout/git commit/git push```等命令时，这些钩子都会自动工作，帮您解决git误操作等问题。
```bash
posture sethook
```
-### (1) checkout钩子
+### (1) checkout钩子
当使用```git checkout```时，会自动执行checkout钩子，如下图所示。
-### (2) pull钩子
+### (2) pull钩子
在使用```git pull```时，会自动执行pull钩子（由post-merge钩子实现），如下图所示。
-### (3) commit钩子
+### (3) commit钩子
当使用```git commit```时，会自动执行commit钩子，如下图所示。
@@ -72,7 +91,7 @@ posture sethook
-提交成功后会触发```post-commit```钩子，自动在```$POSTUREPATH/storage/```目录下生成一条以天为单位的```commit.${day}.log```commit日志文件
+提交成功后会触发```post-commit```钩子，自动在```$POSTUREPATH/storage/```目录下生成一条以天为单位的```commit.${day}.log```commit日志文件，以实现每日工作统计等功能。
```text
# 日志内容如下
@@ -85,7 +104,7 @@ posture sethook
-------------------------------------------------------------
```
-### (4) push钩子
+### (4) push钩子
当使用```git push```时，会自动执行push钩子，如下图所示。
@@ -94,9 +113,9 @@ posture sethook
-## 四、卸载更新
+# 四、卸载更新
-### 1、卸载应用
+## 1、卸载应用
如果需要卸载，在执行完以下命令后，手动删除```$POSTUREPATH```目录即可。
```bash
@@ -105,7 +124,7 @@ cd $POSTUREPATH && bash ./uninstall.sh
-### 2、版本更新
+## 2、版本更新
为保证您的良好使用体验，建议使用最新版的posture工具，执行以下命令即可完成更新。
```bash
@@ -115,6 +134,6 @@ posture update
-## 五、项目贡献
+# 五、项目贡献
