kvdb-client 0.1.0 → 0.1.1

package/README.ja.md

@@ -10,14 +10,73 @@ npm install kvdb-client
 
 ## クイックスタート
 
+### 1) バケット作成サンプル
+
+```js
+import { KVdbClient } from "kvdb-client";
+
+const email = process.env.KVDB_EMAIL; // 自分のメール
+
+if (!email) {
+  throw new Error("KVDB_EMAIL is required");
+}
+
+const bucket = await KVdbClient.createBucket(email);
+console.log("bucket:", bucket);
+```
+
+メールドレスを指定して実行するだけでバケットが作成できます。
+
+### 2) データの出し入れサンプル
+
 ```js
 import { KVdbClient } from "kvdb-client";
 
-const kv = new KVdbClient({ bucket: "YOUR_BUCKET" });
+const bucket = process.env.KVDB_BUCKET; // 作成したバケットのID
+const token = process.env.KVDB_TOKEN; // （なくてOK 任意）
+
+if (!bucket) {
+  throw new Error("KVDB_BUCKET is required");
+}
+
+const kv = new KVdbClient({ bucket, token });
 
 await kv.set("myName", "n0bisuke");
 const name = await kv.get("myName");
-console.log(name);
+console.log("myName:", name);
+
+await kv.set("myData", { name: "test", value: 123 }, { json: true });
+const data = await kv.get("myData", { parseJson: true });
+console.log("myData:", data);
+
+const keys = await kv.list();
+console.log("keys:", keys);
+```
+
+この辺は公式にもあるのでお好きな方をどうぞ。
+
+### 3) データ操作のトランザクションサンプル
+
+公式になかったトランザクションです。まとめて処理したいときに便利です。
+
+```js
+import { KVdbClient } from "kvdb-client";
+
+const bucket = process.env.KVDB_BUCKET;
+const token = process.env.KVDB_TOKEN; // （なくてOK 任意）
+
+if (!bucket) {
+  throw new Error("KVDB_BUCKET is required");
+}
+
+const kv = new KVdbClient({ bucket, token });
+
+await kv.transaction([
+  { set: "users:email:new@example.com", value: "user 1" },
+  { delete: "users:email:old@example.com" }
+]);
+
+console.log("transaction done");
 ```
 
 ## 認証
@@ -140,6 +199,10 @@ await kv.deleteBucket();
 - `token` は `curl -u 'token:'` と同じ形式で送信されます。
 - KVdb に保存した情報がどのように扱われるかについて、SDK 開発者（n0bisuke）は一切把握していません。利用は自己責任とし、トラブル等について開発者は責任を負いません。
 
+## 参考記事
+
+- `https://qiita.com/n0bisuke/items/540478c314a09ee14ba9`
+
 ## Language
 
 - English: `README.md`

package/README.md

@@ -10,14 +10,69 @@ npm install kvdb-client
 
 ## Quick Start
 
+### 1) Create a bucket
+
 ```js
 import { KVdbClient } from "kvdb-client";
 
-const kv = new KVdbClient({ bucket: "YOUR_BUCKET" });
+const email = process.env.KVDB_EMAIL; // your email
+
+if (!email) {
+  throw new Error("KVDB_EMAIL is required");
+}
+
+const bucket = await KVdbClient.createBucket(email);
+console.log("bucket:", bucket);
+```
+
+You can create a bucket just by providing an email address.
+
+### 2) Read & write data
+
+```js
+import { KVdbClient } from "kvdb-client";
+
+const bucket = process.env.KVDB_BUCKET; // your bucket id
+const token = process.env.KVDB_TOKEN; // optional
+
+if (!bucket) {
+  throw new Error("KVDB_BUCKET is required");
+}
+
+const kv = new KVdbClient({ bucket, token });
 
 await kv.set("myName", "n0bisuke");
 const name = await kv.get("myName");
-console.log(name);
+console.log("myName:", name);
+
+await kv.set("myData", { name: "test", value: 123 }, { json: true });
+const data = await kv.get("myData", { parseJson: true });
+console.log("myData:", data);
+
+const keys = await kv.list();
+console.log("keys:", keys);
+```
+
+### 3) Transaction (batch operations)
+
+```js
+import { KVdbClient } from "kvdb-client";
+
+const bucket = process.env.KVDB_BUCKET;
+const token = process.env.KVDB_TOKEN; // optional
+
+if (!bucket) {
+  throw new Error("KVDB_BUCKET is required");
+}
+
+const kv = new KVdbClient({ bucket, token });
+
+await kv.transaction([
+  { set: "users:email:new@example.com", value: "user 1" },
+  { delete: "users:email:old@example.com" }
+]);
+
+console.log("transaction done");
 ```
 
 ## Authentication
@@ -140,6 +195,10 @@ await kv.deleteBucket();
 - `token` for Basic auth is sent as `curl -u 'token:'`.
 - The SDK author (n0bisuke) has no knowledge of how data stored in KVdb is handled; use at your own risk. The author is not responsible for any issues or damages.
 
+## Related Article
+
+- `https://qiita.com/n0bisuke/items/540478c314a09ee14ba9`
+
 ## Language
 
 - English (this file)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kvdb-client",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Simple Node.js client for kvdb.io",
   "type": "module",
   "main": "./src/index.js",