update readme

ECNU · Dec 29, 2024 · 10d75aa · 10d75aa
1 parent a9b23c5
commit 10d75aa
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -17,29 +17,34 @@ Open-OAuth2Playground 是一个仿 Google [OAuth 2.0 Playground](https://develop
 **[ 目录 ]**
 
 - [Open-OAuth2Playground](#open-oauth2playground)
-    - [安装运行](#安装运行)
-        - [方式一、docker 一键部署运行](#方式一docker-一键部署运行)
-        - [方式二、源码编译运行](#方式二源码编译运行)
-            - [1. 获取项目源码](#1-获取项目源码)
-            - [2. 修改配置文件](#2-修改配置文件)
-            - [2. 修改配置文件](#2-修改配置文件)
-            - [3. 前端编译](#3-前端编译)
-            - [4. 后端编译](#4-后端编译)
-            - [5. 运行](#5-运行)
-            - [统一打包](#统一打包)
-        - [方式三：二进制包-解压后直接运行](#方式三二进制包-解压后直接运行)
-            - [Linux](#linux)
-            - [Windows](#windows)
-        - [方式四：二进制包-systemctl 托管运行](#方式四二进制包---systemctl-托管运行)
-    - [配置](#配置)
-        - [一、后端配置](#一后端配置)
-            - [后端配置说明](#后端配置说明)
-        - [二、前端配置](#二前端配置)
-            - [前端配置说明](#前端配置说明)
-        - [三、前端项目单独部署](#三前端项目单独部署)
-            - [定制化前端菜单](#定制化前端菜单)
-    - [使用](#使用)
-    - [鸣谢](#鸣谢)
+  - [安装运行](#安装运行)
+    - [方式一、docker 一键部署运行](#方式一docker-一键部署运行)
+    - [方式二、源码编译运行](#方式二源码编译运行)
+      - [前期准备：](#前期准备)
+      - [1. 获取项目源码](#1-获取项目源码)
+      - [2. 修改配置文件](#2-修改配置文件)
+      - [3. 前端编译](#3-前端编译)
+      - [4. 后端编译](#4-后端编译)
+      - [5. 运行](#5-运行)
+      - [统一打包](#统一打包)
+    - [方式三：二进制包-解压后直接运行](#方式三二进制包-解压后直接运行)
+      - [Linux](#linux)
+      - [Windows](#windows)
+    - [方式四：二进制包 - systemctl 托管运行](#方式四二进制包---systemctl-托管运行)
+  - [配置](#配置)
+    - [一、后端配置](#一后端配置)
+      - [后端配置说明](#后端配置说明)
+    - [二、前端配置](#二前端配置)
+      - [前端配置说明](#前端配置说明)
+    - [三、前端项目单独部署](#三前端项目单独部署)
+      - [定制化前端菜单](#定制化前端菜单)
+  - [使用](#使用)
+    - [一、Authorization Code 模式](#一authorization-code-模式)
+    - [二、Resource Owner Password Credentials 模式](#二resource-owner-password-credentials-模式)
+    - [三、Client Credentials 模式](#三client-credentials-模式)
+    - [四、Device Flow 模式](#四device-flow-模式)
+    - [五、PKCE 模式](#五pkce-模式)
+  - [鸣谢](#鸣谢)
 
 ---
 
@@ -60,7 +65,7 @@ docker 运行方式
 ![docker 容器模式下 oauth2playground 结构图](imgs/docker-container.svg)
 
 ```shell
-docker-compose -p oauth-server-lite up -d
+docker-compose  up -d
 ```
 
 **注意事项**

diff --git a/README_en.md b/README_en.md
@@ -17,28 +17,34 @@ When deployed on the server side, it is also ideal for synchronizing with OAuth2
 **[Table of Contents]**
 
 - [Open-OAuth2Playground](#open-oauth2playground)
-	- [Installation and Operation](#installation-and-operation)
-		- [Method One: Docker One-click Deployment and Operation](#Method-One-Docker-One-click-Deployment-and-Operation)
-		- [Method Two: Source Code Compilation and Operation](#Method-Two-Source-Code-Compilation-and-Operation)
-			- [1. Obtain the Project Source Code](#1-Obtain-the-Project-Source-Code)
-			- [2. Modify the Configuration File](#2-Modify-the-Configuration-File)
-			- [3. Front-end Compilation](#3-Front-end-Compilation)
-			- [4. Back-end Compilation](#4-Back-end-Compilation)
-			- [5. Operation](#5-Operation)
-			- [Unified Packaging](#Unified-Packaging)
-		- [Method Three: Binary Package - Unzip and Run Directly](#Method-Three-Binary-Package---Unzip-and-Run-Directly)
-			- [Linux](#Linux)
-			- [Windows](#Windows)
-		- [Method Four: Binary Package - Systemctl Hosted Operation](#Method-Four-Binary-Package---Systemctl-Hosted-Operation)
-	- [Configuration](#configuration)
-		- [I. Backend Configuration](#I-Backend-Configuration)
-			- [Backend Configuration Description](#Backend-Configuration-Description)
-		- [II. Frontend Configuration](#II-Frontend-Configuration)
-			- [Frontend Configuration Description](#Frontend-Configuration-Description)
-		- [III. Frontend Project Independent Deployment](#III-Frontend-Project-Independent-Deployment)
-			- [Customized Frontend Menu](#Customized-Frontend-Menu)
-	- [Usage](#usage)
-	- [Acknowledgements](#acknowledgements)
+  - [Installation and Operation](#installation-and-operation)
+    - [Method One: Docker One-click Deployment and Operation](#method-one-docker-one-click-deployment-and-operation)
+    - [Method Two: Source Code Compilation and Operation](#method-two-source-code-compilation-and-operation)
+      - [Prerequisites:](#prerequisites)
+      - [1. Obtain the Project Source Code](#1-obtain-the-project-source-code)
+      - [2. Modify the Configuration File](#2-modify-the-configuration-file)
+      - [3. Front-end Compilation](#3-front-end-compilation)
+      - [4. Back-end Compilation](#4-back-end-compilation)
+      - [5. Operation](#5-operation)
+      - [Unified Packaging](#unified-packaging)
+    - [Method Three: Binary Package - Unzip and Run Directly](#method-three-binary-package---unzip-and-run-directly)
+      - [Linux](#linux)
+      - [Windows](#windows)
+    - [Method Four: Binary Package - Systemctl Hosted Operation](#method-four-binary-package---systemctl-hosted-operation)
+  - [Configuration](#configuration)
+    - [I. Backend Configuration](#i-backend-configuration)
+      - [Backend Configuration Description](#backend-configuration-description)
+    - [II. Frontend Configuration](#ii-frontend-configuration)
+      - [Frontend Configuration Description](#frontend-configuration-description)
+    - [III. Frontend Project Independent Deployment](#iii-frontend-project-independent-deployment)
+      - [Customized Frontend Menu](#customized-frontend-menu)
+  - [Usage](#usage)
+    - [I. Authorization Code Mode](#i-authorization-code-mode)
+    - [II. Resource Owner Password Credentials Mode](#ii-resource-owner-password-credentials-mode)
+    - [III. Client Credentials Mode](#iii-client-credentials-mode)
+    - [IV. Device Flow Mode](#iv-device-flow-mode)
+    - [V. PKCE Mode](#v-pkce-mode)
+  - [Acknowledgements](#acknowledgements)
 
 ---
 
@@ -59,7 +65,7 @@ The project provides a `docker-compose.yaml` file, which can be started with one
 ![Docker container mode oauth2playground structure chart](imgs/docker-container.svg)
 
 ```shell
-docker-compose -p oauth-server-lite up -d
+docker-compose up -d
 ```
 
 **Notes**