From 47edfdd093146f506cb9ced64232c69dfb2afe44 Mon Sep 17 00:00:00 2001
From: Kentaro1043 <71170923+Kentaro1043@users.noreply.github.com>
Date: Tue, 12 Nov 2024 14:57:05 +0900
Subject: [PATCH] =?UTF-8?q?=E3=83=89=E3=82=AD=E3=83=A5=E3=83=A1=E3=83=B3?=
 =?UTF-8?q?=E3=83=88?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index da47066..b44d18b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
 # s3-backup-helper
- traQのオブジェクトストレージのバックアップツール
+ オブジェクトストレージのバックアップツール
+
+ S3バケットごとにGCSバケットを作成し、各オブジェクトをSnappyで圧縮してアップロード、全て完了したらtraQにWebhookを送信する。
+
+# 実行
+ ```go
+ go run .
+ ```
+
+ `decompress`フォルダに単一ファイル解凍用のコードがある。
+
+ ```go
+ go run decompress/main.go /path/to/snappy/file
+ ```
+
+# 設定
+ `sample.env`から`.env`を作るか、環境変数で指定する。
+ 
+ `GCS_BUCKET_NAME_SUFFIX`: GCSバケットが<S3バケット名> + `GCS_BUCKET_NAME_SUFFIX`という名前で作られる。  
+ （GCSバケット名がグローバルでユニークである必要があるため）
+
+ `PALALELL_NUM`: 同時に処理するオブジェクトの数