Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
imsobear committed Mar 24, 2022
1 parent a19d258 commit 6981177
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
16 changes: 8 additions & 8 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ English | [简体中文](./README.md)

| Version | Branch | Docs |
| --- | --- | --- |
| V2 | master | [Docs](https://github.com/ice-lab/icestore#documents)
| V2 | master | [Docs](https://github.com/ice-lab/icestore#文档)
| V1 | stable/1.x | [Docs](https://github.com/ice-lab/icestore/tree/stable/1.x#documents)

## Introduction
Expand All @@ -27,6 +27,13 @@ icestore is a simple and friendly state management library for React. It has the

See the [comparison table](docs/recipes.md#能力对比表) for more details.

## Documents

- [API](./docs/api.md)
- [Recipes](./docs/recipes.md)
- [Upgrade from V1](./docs/upgrade-guidelines.md)
- [Q & A](./docs/qna.md)

## Examples

- [Counter](https://codesandbox.io/s/github/ice-lab/icestore/tree/master/examples/counter)
Expand Down Expand Up @@ -106,13 +113,6 @@ icestore requires React 16.8.0 or later.
npm install @ice/store --save
```

## Documents

- [API](./docs/api.md)
- [Recipes](./docs/recipes.md)
- [Upgrade from V1](./docs/upgrade-guidelines.md)
- [Q & A](./docs/qna.md)

## Inspiration

icestore refines and builds upon the ideas of [rematch](https://github.com/rematch/rematch) & [constate](https://github.com/diegohaz/constate).
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
简体中文 | [English](./README.cn.md)
简体中文 | [English](./README.en.md)

# icestore

Expand All @@ -13,10 +13,10 @@

| 版本 | 代码分支 | 文档 |
| --- | --- | --- |
| V2 | master | [Docs](https://github.com/ice-lab/icestore#documents)
| V2 | master | [Docs](https://github.com/ice-lab/icestore#文档)
| V1 | stable/1.x | [Docs](https://github.com/ice-lab/icestore/tree/stable/1.x#documents)

## 安装
## 介绍

icestore 是面向 React 应用的、简单友好的状态管理方案。它包含以下核心特征:

Expand All @@ -27,6 +27,13 @@ icestore 是面向 React 应用的、简单友好的状态管理方案。它包

查看[《能力对比表》](docs/recipes.md#Comparison)了解更多细节。

## 文档

- [API](./docs/api.md)
- [更多技巧](./docs/recipes.md)
- [从 V1 版本升级](./docs/upgrade-guidelines.md)
- [常见问题](./docs/qna.md)

## 示例

- [Counter](https://codesandbox.io/s/github/ice-lab/icestore/tree/master/examples/counter)
Expand Down Expand Up @@ -101,13 +108,6 @@ ReactDOM.render(<App />, rootElement);
$ npm install @ice/store --save
```

## 文档

- [API](./docs/api.md)
- [更多技巧](./docs/recipes.md)
- [从 V1 版本升级](./docs/upgrade-guidelines.md)
- [常见问题](./docs/qna.md)

## 灵感

创造 icestore 的灵感来自于 [rematch](https://github.com/rematch/rematch)[constate](https://github.com/diegohaz/constate)
Expand Down

0 comments on commit 6981177

Please sign in to comment.