Skip to content

Commit

Permalink
docs: update readme (#76)
Browse files Browse the repository at this point in the history
  • Loading branch information
callqh authored May 29, 2024
1 parent e88a355 commit d6d53dd
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 56 deletions.
45 changes: 0 additions & 45 deletions README.cn.md

This file was deleted.

48 changes: 48 additions & 0 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<div align="center">

<!-- <h3>Farm-react Starter Template</h3> -->
<p>
<img src="./src/assets/logo.png" width="30" align="center" />
An out-of-the-box Farm-react development template
</p>
<p align="center">
<a href="https://discord.gg/mDErq9aFnF">
<img src="https://img.shields.io/badge/chat-discord-blueviolet?style=flat&logo=discord&colorA=ffe3f5&colorB=711a5f" alt="discord chat" />
</a>
<a href="https://npmjs.com/package/@farmfe/core">
<img src="https://img.shields.io/npm/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="npm package">
</a>
<a href="https://nodejs.org/en/about/releases/">
<img src="https://img.shields.io/node/v/@farmfe/core.svg?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="node compatibility">
</a>
<a href="https://github.com/farm-fe/farm/blob/main/LICENSE">
<img src="https://img.shields.io/npm/l/@farmfe/core?style=flat-square&colorA=ffe3f5&colorB=711a5f" alt="license" />
</a>
</p>
<br/>
</div>

<p>
<img src="https://github.com/jstors/assets/blob/main/home.jpeg" align="center" />
</p>

> For a better development experience, please install the [**Biome plugin**](https://biomejs.dev/en/reference/vscode/) on your local development tool.

## RoadMap

[RoadMap](https://github.com/jstors/farm-react-template/issues/21)

## Usage

### User Configuration

All configuration files are located in the `config` directory and can be modified according to your needs.
- `config/const.ts`: Contains constants used in the project.
- `config/menu.ts`: Menu configuration

## Integrated Features
- [Farm](https://farm-fe.github.io/en/docs/quick-start): A Rust-based foundation framework that provides a complete development experience.
- [Biome](https://biomejs.dev/en/reference/configuration/#javascriptformatterjsxquotestyle): A Rust-based linting and formatting tool that enhances the development experience.
- [Ant Design](https://ant.design/components/overview-cn/): An out-of-the-box React component library, use version 5.x.
- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): Provides a routing system based on conventions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<!-- <h3>Farm-react Starter Template</h3> -->
<p>
<img src="./src/assets/logo.png" width="30" align="center" />
An out-of-the-box Farm-react development template
开箱即用的 `Farm-react-admin` 开发模板
</p>
<p align="center">
<a href="https://discord.gg/mDErq9aFnF">
Expand All @@ -26,23 +26,23 @@
<img src="https://github.com/jstors/assets/blob/main/home.jpeg" align="center" />
</p>

> For a better development experience, please install the [**Biome plugin**](https://biomejs.dev/en/reference/vscode/) on your local development tool.
> 为获得更好的开发体验,请在本地开发工具上安装 [**Biome 插件**](https://biomejs.dev/en/reference/vscode/)

## RoadMap

[RoadMap](https://github.com/jstors/farm-react-template/issues/21)

## Usage
## 使用

### User Configuration
### 用户配置

All configuration files are located in the `config` directory and can be modified according to your needs.
- `config/const.ts`: Contains constants used in the project.
- `config/menu.ts`: Menu configuration
所有配置文件都位于 `config` 目录中,可以根据需要进行修改。
- `config/const.ts`: 包含在项目中使用的常量
- `config/menu.ts`: 菜单配置

## Integrated Features
- [Farm](https://farm-fe.github.io/en/docs/quick-start): A Rust-based foundation framework that provides a complete development experience.
- [Biome](https://biomejs.dev/en/reference/configuration/#javascriptformatterjsxquotestyle): A Rust-based linting and formatting tool that enhances the development experience.
- [Ant Design](https://ant.design/components/overview-cn/): An out-of-the-box React component library, use version 5.x.
- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): Provides a routing system based on conventions.
- [Farm](https://farm-fe.github.io/en/docs/quick-start): 一个基于Rust的基础框架,提供完整的开发体验
- [Biome](https://biomejs.dev/en/reference/configuration/#javascriptformatterjsxquotestyle): 一个基于Rust的代码检查和格式化工具,可以增强开发体验
- [Ant Design](https://ant.design/components/overview-cn/): 开箱即用的 React 组件库,使用版本 5.x
- [vite-plugin-pages](https://github.com/hannoeru/vite-plugin-pages?tab=readme-ov-file#react-1): 基于约定的路由系统

0 comments on commit d6d53dd

Please sign in to comment.