Skip to content
This repository has been archived by the owner on Aug 12, 2024. It is now read-only.

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
windchime-yk committed Aug 24, 2022
1 parent 189072a commit c9ee500
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ DB module in JSON format created with Deno.
- [x] Asynchronous support
- [x] Partial search with regular expressions

If you don't see a feature you think you need, please let us know what you want in [Issue](https://github.com/windchime-yk/bracesdb/issues/new). It will be used as a reference for implementation.
If you don't see a feature you think you need, please let us know what you want in [Issue](https://github.com/rwl-dev/bracesdb/issues/new). It will be used as a reference for implementation.

## API
When creating a file, you must add `--allow-read` and `--allow-write` at execution to read and write the file.
Expand All @@ -32,7 +32,7 @@ When creating a file, you must add `--allow-read` and `--allow-write` at executi
`filename` is the DB name. Default name is `main`.

``` typescript
import { BracesDB } from "https://deno.land/x/bracesdb/mod.ts";
import { BracesDB } from "https://deno.land/x/bracesdb@<version>/mod.ts";

interface DB {
name?: string;
Expand Down Expand Up @@ -80,7 +80,7 @@ const dataAll = db.find();
### Test
Execute the following command.
``` bash
$ git clone git@github.com:windchime-yk/bracesdb.git
$ git clone https://github.com/rwl-dev/bracesdb.git
$ cd path/to/bracesdb

$ deno task test
Expand Down
6 changes: 3 additions & 3 deletions README_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Denoで作られたJSON形式のDBモジュール。
- [x] 非同期対応
- [x] 正規表現による部分検索

もし必要だと思う機能がなければ、[Issues](https://github.com/windchime-yk/bracesdb/issues/new)で教えてください。参考にします。
もし必要だと思う機能がなければ、[Issues](https://github.com/rwl-dev/bracesdb/issues/new)で教えてください。参考にします。

## API
ファイルを作成する保存形式では、ファイルの読み込みと書き込みを行なうため、実行の際に`--allow-read``--allow-write`をつけてください。
Expand All @@ -31,7 +31,7 @@ Denoで作られたJSON形式のDBモジュール。
`folder`はDBファイルを格納するフォルダのパスです。デフォルトではプロジェクトルートに生成されます。
`filename`はDBファイルの名前です。デフォルトは`main`です。
``` typescript
import { BracesDB } from "https://deno.land/x/bracesdb/mod.ts";
import { BracesDB } from "https://deno.land/x/bracesdb@<version>/mod.ts";

interface DB {
name?: string;
Expand Down Expand Up @@ -80,7 +80,7 @@ const dataAll = db.find();
## テスト
以下のコマンドを実行してください。
``` bash
$ git clone git@github.com:windchime-yk/bracesdb.git
$ git clone https://github.com/rwl-dev/bracesdb.git
$ cd path/to/bracesdb

$ deno task test
Expand Down

0 comments on commit c9ee500

Please sign in to comment.