Skip to content

Commit

Permalink
docs: 📝 update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cworld1 committed Nov 29, 2024
1 parent 78d3ced commit 99da788
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 25 deletions.
18 changes: 6 additions & 12 deletions README-zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@

## 简介 / 部署

[预览](https://astro-theme-pure.vercel.app/) | [展示台](https://github.com/cworld1/astro-theme-pure/issues/10)
查看 [预览](https://astro-theme-pure.vercel.app/)

欲了解更多信息,请访问 [CWorld 网站](https://cworld0.com/blog/theme-resume)[部署说明](https://astro-theme-pure.vercel.app/blog/customize-zh)
## 使用

[文档](https://astro-theme-pure.vercel.app/docs/list) | [展示台](https://github.com/cworld1/astro-theme-pure/issues/10)

## 本地开发

Expand All @@ -36,16 +38,6 @@ cd astro-theme-pure
bun install
```

> [!NOTE]
> 对于 Bun,如果安装较慢,建议使用镜像配置,在项目根目录下新建 `bunfig.toml`
>
> ```toml
> [install]
> registry = "https://registry.npmmirror.com/"
> ```
>
> 其他 PM 配置镜像请参考各自官方文档。
启动开发服务器:

```shell
Expand Down Expand Up @@ -78,3 +70,5 @@ bun preview
## 许可证

本项目基于 Apache 2.0 许可证。

[![Star History Chart](https://api.star-history.com/svg?repos=cworld1/astro-theme-pure&type=Date)](https://star-history.com/#cworld1/astro-theme-pure&Date)
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ A simple, clean but powerful blog theme build by astro.

![image](https://github.com/user-attachments/assets/7eb17ddf-fd5f-42f3-a337-675a21ba7a27)

## Introduction / Deployment
## Introduction

[Demo](https://astro-theme-pure.vercel.app/) | [Showcase](https://github.com/cworld1/astro-theme-pure/issues/10)
Checkout [Demo Site →](https://astro-theme-pure.vercel.app/)

For more information, please visit the [CWorld Site](https://cworld0.com/blog/theme-resume) and [Deployment Instructions](https://astro-theme-pure.vercel.app/blog/customize).
## Usage

[Docs](https://astro-theme-pure.vercel.app/docs/list) | [Showcase](https://github.com/cworld1/astro-theme-pure/issues/10)

## Local development

Expand All @@ -37,16 +39,6 @@ cd astro-theme-pure
bun install
```

> [!NOTE]
> For Bun, if the installation is slow, it is recommended to use a mirror configuration by creating `bunfig.toml` under the project root directory:
>
> ```toml
> [install]
> registry = "<npm mirror site>"
> ```
>
> For details about other PM mirror configs, you may need to see their official documents.
Start the development server:

```shell
Expand Down

0 comments on commit 99da788

Please sign in to comment.