shinten-ship 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.ja.md +19 -0
  2. package/README.md +21 -0
  3. package/package.json +1 -1
package/README.ja.md CHANGED
@@ -109,6 +109,25 @@ shinten-ship purge labels.csv
109
109
 
110
110
  業者の形式は業者の都合で変わります。形式は `src/carriers/` の1ファイルです。
111
111
 
112
+ ## 例
113
+
114
+ [shinten の web-shop の例](https://github.com/eucassoc/shinten/tree/main/examples/web-shop)
115
+ で、架空のネットショップの出荷担当の端末を動かせます。暗号化された注文からヤマト運輸
116
+ B2クラウドの取込ファイルを作り、印刷後に削除し、サイトが承認していない鍵を配っていた
117
+ ときには止まります。流れは[約2分の動画](https://github.com/eucassoc/shinten/blob/main/examples/web-shop/demo.mp4)で見られます。
118
+
119
+ 受付から復号、削除までの各手順は [deedlog](https://github.com/eucassoc/deedlog) で記録し、
120
+ 二つの連署サーバーが連署します。そのため、例を動かすには `dlog` コマンドが必要です
121
+ (Go が必要です)。
122
+
123
+ ```sh
124
+ go install github.com/eucassoc/deedlog/cmd/dlog@latest
125
+
126
+ git clone https://github.com/eucassoc/shinten && cd shinten/examples/web-shop
127
+ npm install
128
+ npm start # http://127.0.0.1:8800/
129
+ ```
130
+
112
131
  ## 開発
113
132
 
114
133
  ```sh
package/README.md CHANGED
@@ -115,6 +115,27 @@ and each purge. No address is ever in a record.
115
115
  Carrier formats change on the carriers' schedule; a format is one file
116
116
  under `src/carriers/`.
117
117
 
118
+ ## Example
119
+
120
+ [shinten's web-shop example](https://github.com/eucassoc/shinten/tree/main/examples/web-shop)
121
+ runs the desk on a fictional shop: Yamato B2 Cloud labels from encrypted
122
+ orders, the file deleted after printing, and the stop when the site has
123
+ served a key the desk never approved.
124
+ [A two-minute video](https://github.com/eucassoc/shinten/blob/main/examples/web-shop/demo.mp4)
125
+ walks through it.
126
+
127
+ Each step, from receipt to decryption and deletion, is also recorded with
128
+ [deedlog](https://github.com/eucassoc/deedlog) and cosigned by two witnesses,
129
+ so running the example needs its `dlog` command (Go required):
130
+
131
+ ```sh
132
+ go install github.com/eucassoc/deedlog/cmd/dlog@latest
133
+
134
+ git clone https://github.com/eucassoc/shinten && cd shinten/examples/web-shop
135
+ npm install
136
+ npm start # http://127.0.0.1:8800/
137
+ ```
138
+
118
139
  ## Development
119
140
 
120
141
  ```sh
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shinten-ship",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "description": "The shipping desk for shinten: opens sealed delivery addresses on the desk's own device and writes the carrier's label-import CSV, so the store never holds an address in the clear.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": "github:eucassoc/shinten-ship",