Skip to content

Commit

Permalink
docs: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
L2ncE committed Jan 23, 2023
1 parent ded49bc commit 330f31e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 6 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,20 @@ FreeCar is a full-stack WeChat applet based on Kitex and Hertz.
## Catalog Introduce

| Catalog | Introduce |
| ------- | ---------------------------- |
|---------|------------------------------|
| Server | Core services of the project |
| Shared | Reusable code |
| Static | Front-end static files |
| Static | WeChat applet code |

## Service Introduce

| Catalog | Introduce |
|---------|----------------------------------------------------|
| Auth | User Authentication Service |
| Blob | Services Related to Pictures and Tencent Cloud COS |
| Car | Car Service |
| Profile | Profile and Picture Recognition Services |
| Trip | Trip Service |

## Quick Start

Expand Down
18 changes: 14 additions & 4 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,21 @@ FreeCar 是一个基于 Hertz 与 Kitex 的全栈项目。

## 目录介绍

| 目录 | 介绍 |
| ------ | ------------ |
| Server | 项目核心部分 |
| 目录 | 介绍 |
|--------|---------|
| Server | 项目核心部分 |
| Shared | 可复用代码 |
| Static | 前端静态文件 |
| Static | 微信小程序代码 |

## 服务介绍

| 目录 | 介绍 |
|---------|-------------------|
| Auth | 用户认证服务 |
| Blob | 与图片和腾讯云 COS 相关的服务 |
| Car | 汽车服务 |
| Profile | 主页与图片识别服务 |
| Trip | 行程服务 |

## 快速开始

Expand Down

0 comments on commit 330f31e

Please sign in to comment.