Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
KenyonY committed Dec 24, 2023
1 parent 0c90daf commit 9da4923
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 6 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ You can use it just like a Python dictionary without having to worry about block

```bash
pip install flaxkv
# Or pip install flaxkv[server]
# Install with server version: pip install flaxkv[server]
```
### Usage

Expand All @@ -78,8 +78,13 @@ from flaxkv import dictdb
import numpy as np

db = dictdb('test_db')
# or run server `flaxkv run --port 8000`, then:
# db = dictdb('test_db', root_path_or_url='http://localhost:8000')
"""
Or start as a server
>>> flaxkv run --port 8000
Client call:
db = dictdb('test_db', root_path_or_url='http://localhost:8000')
"""

db[1] = 1
db[1.1] = 1 / 3
Expand Down
12 changes: 9 additions & 3 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
### 安装
```bash
pip install flaxkv
# Or pip install flaxkv[server]
# 安装带服务端版本:pip install flaxkv[server]
```

### 使用
Expand All @@ -82,8 +82,14 @@ from flaxkv import dictdb
import numpy as np

db = dictdb('test_db')
# or run server `flaxkv run --port 8000`, then:
# db = dictdb('test_db', root_path_or_url='http://localhost:8000')

"""
或者作为服务端启动
>>> flaxkv run --port 8000
客户端调用:
db = dictdb('test_db', root_path_or_url='http://localhost:8000')
"""

db[1] = 1
db[1.1] = 1 / 3
Expand Down

0 comments on commit 9da4923

Please sign in to comment.