Merge pull request #19 from yukiarrr/fix-readme

Fix README

README.ja.md

@@ -4,7 +4,7 @@
 
 Chrome拡張だけで、Spreadsheetのシート同士をマージし、それをcsvとしてGitHubにプッシュすることができるマスタデータ管理ツールです。
 
-<p align="center"><img width="600" src="/~https://github.com/yukiarrr/MasterBird/raw/master/docs/images/masterbird.gif" alt="MasterBird gif"></p>
+<p align="center"><img width="700" src="/~https://github.com/yukiarrr/MasterBird/raw/master/docs/images/masterbird.gif" alt="MasterBird gif"></p>
 
 ## 目次
 
@@ -46,7 +46,7 @@ Chrome拡張だけで、Spreadsheetのシート同士をマージし、それを
 7. 更新後に承認を求められるので、説明に従って承認してください
 8. [こちら](#extension-configjsonについて)を参考に、`MasterBird/examples/extension-config.json`を編集します（applyUrlはこの手順の5の完了後に表示されるURLを使用してください）
 9. 設定ファイルをチームメンバーがアクセスできるGoogle Drive上の場所で右クリックし、`ファイルをアップロード`で編集した`extension-config.json`をアップロードします
-10. アップロードした`extension-config.json`を右クリックし、`共有可能なリンクを取得`を選択し、取得した`https://drive.google.com/open?id=XXXXXXX`のうち、`XXXXXXX`の部分をIDとしてメモしてください（Chrome拡張導入時にConfig File Idとして必要となります）
+10. アップロードした`extension-config.json`を右クリックし、`共有可能なリンクを取得`を選択し、取得した`https://drive.google.com/file/d/XXXXXXX/view?usp=sharing`のうち、`XXXXXXX`の部分をIDとしてメモしてください（Chrome拡張導入時にConfig File Idとして必要となります）
 
 ### 全メンバー
 
@@ -59,7 +59,7 @@ Chrome拡張だけで、Spreadsheetのシート同士をマージし、それを
 7. 管理者指定のGoogleアカウントでログインしてください
 8. Spreadsheetの画面や、Google DriveのSpreadsheetが存在するフォルダの画面にいくと、Chromeの右上のMasterBirdアイコンが押せるようになるので、それを押してください
 9. 情報の入力を求められるので、入力してください（GitHub Access Tokenは、この手順の4で取得したものを使用してください）
-10. Config File IdとApply Passwordは、管理者から教えてもらってください
+10. Config File IdとApply Passwordは、管理者から教えてもらってください（省略した場合、Apply Passwordは不要です）
 
 ### `extension-config.json`について
 

README.md

@@ -4,11 +4,11 @@
 
 This is a master data management tool that can merge sheets in Spreadsheet and push it to GitHub as csv, using only the Chrome Extension.
 
-<p align="center"><img width="600" src="/~https://github.com/yukiarrr/MasterBird/raw/master/docs/images/masterbird.gif" alt="MasterBird gif"></p>
+<p align="center"><img width="700" src="/~https://github.com/yukiarrr/MasterBird/raw/master/docs/images/masterbird.gif" alt="MasterBird gif"></p>
 
 ## Table of contents
 
-- [Overview](#Overview)
+- [Overview](#overview)
 - [Getting started](#getting-started)
   - [Administrator only](#administrator-only)
   - [All members](#all-members)
@@ -18,7 +18,7 @@ This is a master data management tool that can merge sheets in Spreadsheet and p
   - [Parameter description](#parameter-description)
   - [Push a sheet directly to GitHub](#push-a-sheet-directly-to-github)
   - [Merge sheets and push it to GitHub](#merge-sheets-and-push-it-to-github)
-  - [Push multiple Spreadsheets to GitHub](#push-multiple-Spreadsheets-to-github)
+  - [Push multiple Spreadsheets to GitHub](#push-multiple-spreadsheets-to-github)
 - [Rules for merging sheets and converting csv](#rules-for-merging-sheets-and-converting-csv)
   - [Basic rules](#basic-rules)
   - [Rules for merging sheets](#rules-for-merging-sheets)
@@ -46,7 +46,7 @@ As an operational flow, we assume that when a csv is pushed to GitHub, it is imp
 7. You will be asked to approve it after the update, so follow the instructions to approve it
 8. Edit MasterBird/examples/extension-config.json with reference to [this](#about-extension-configjson) (use the URL that appears after the completion of step 5 of this procedure for applyUrl)
 9. Right-click on the configuration file in a location on Google Drive that your team members can access and upload the `extension-config.json` that you edited in `Upload files`
-10. Right-click on the uploaded `extension-config.json`, select `Get shareable link`, and note the `XXXXXXX` part of `https://drive.google.com/open?id=XXXXXXX` as the ID (it will be required as Config File Id when the Chrome extension is installed)
+10. Right-click on the uploaded `extension-config.json`, select `Get shareable link`, and note the `XXXXXXX` part of `https://drive.google.com/file/d/XXXXXXX/view?usp=sharing` as the ID (it will be required as Config File Id when the Chrome extension is installed)
 
 ### All members
 
@@ -57,9 +57,9 @@ As an operational flow, we assume that when a csv is pushed to GitHub, it is imp
 5. Please refer to [this page](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line) and check the "repo" box in step 7 of the reference, and then issue the GitHub access token
 6. Go to `chrome://extensions`, turn on developer mode in the upper right corner, and select `MasterBird/extension/app` under "LOAD UNPACKED"
 7. Please log in with your administrator-designated Google account
-8. When you go to the Spreadsheet screen or the folder where Spreadsheet is located in Google Drive, you will be able to press the MasterBird icon in the upper right corner of Chrome
+8. When you go to Spreadsheet screen or the folder where Spreadsheet is located in Google Drive, you will be able to press the MasterBird icon in the upper right corner of Chrome
 9. You will be asked for information, so enter it (use the GitHub Access Token you got in step 4 of this procedure)
-10. Config File Id and Apply Password should be told to you by your administrator
+10. Config File Id and Apply Password should be told to you by your administrator (if omitted, Apply Password is not necessary)
 
 ### About `extension-config.json`
 
@@ -92,9 +92,9 @@ As an operational flow, we assume that when a csv is pushed to GitHub, it is imp
 
 |Parameter|Description|
 |:-:|:-:|
-|Apply Spreadsheets|Spreadsheets that are subject to Apply.<br />Automatic selection on the spreadsheet and multiple selections on Google Drive.|
+|Apply Spreadsheets|Spreadsheets that are subject to Apply.<br />Automatic selection on Spreadsheet and multiple selections on Google Drive.|
 |Target Sheet|The sheet to be pushed to.<br />If it doesn't exist, it will be created automatically.<br />The name of the branch to be pushed is the same as the name of the sheet.|
-|Overlay Sheets|Sheet to overwrite Target Sheet.<br />Multiple sheets can be selected, in which case, the sheets are overwritten in the order of input.|
+|Overlay Sheets|The sheet to overwrite Target Sheet.<br />Multiple sheets can be selected, in which case, the sheets are overwritten in the order of input.|
 |Base Branch|The name of the branch to use as a base if the branch with Target Sheet name does not exist and is newly created.|
 
 ### Push a sheet directly to GitHub
@@ -116,8 +116,8 @@ As an operational flow, we assume that when a csv is pushed to GitHub, it is imp
 
 ### Push multiple Spreadsheets to GitHub
 
-1. Go to the Google Drive folder screen that contains the Spreadsheet you want to reflect.
-2. In the 'Apply Spreadsheets' section, select the spreadsheet you want to reflect.
+1. Go to the Google Drive folder screen that contains Spreadsheet you want to reflect.
+2. In the 'Apply Spreadsheets' section, select Spreadsheet you want to reflect.
 3. As for "Target Sheet" and "Overlay Sheets", it is the same as [Merge sheets and push it to GitHub](#merge-sheets-and-push-it-to-github), and is applied to all selected Spreadsheets.
 4. press "Apply".
 5. if "Success 🎉" comes up, it's a success!

cli/msbird/README.ja.md

@@ -77,7 +77,7 @@ $ msbird init --config cli-config.json
   // CLIからリポジトリにcsvを参照するために必要なAccess Token
   "gitHubAccessToken": "",
 
-  // `sync.gs`導入時に設定したパスワード（省略した場合は不要）
+  // sync.gs導入時に設定したパスワード（省略した場合は不要）
   "syncPassword": "",
 
   // Google API Consoleで作成したClient Id
@@ -125,7 +125,7 @@ $ msbird init --config cli-config.json --service-account service-account.json
   // CLIからリポジトリにcsvを参照するために必要なAccess Token
   "gitHubAccessToken": "",
 
-  // `sync.gs`導入時に設定したパスワード（省略した場合は不要）
+  // sync.gs導入時に設定したパスワード（省略した場合は不要）
   "syncPassword": ""
 }
 ```
@@ -143,6 +143,6 @@ Pull Requestが対象のブランチにマージされた際に、その変更
 $ msbird sync --csv-path csvs/example.csv --sheet-name develop
 ```
 
-この例では、Google Driveに「csvs」フォルダと「example」スプレッドシートが存在しない場合は作成後、そのスプレットシートに"develop"シートがなければ作成し、そこにcsvデータを書き込んでいます。
+この例では、Google Driveに「csvs」フォルダと「example」スプレッドシートが存在しない場合は作成後、そのスプレットシートに「develop」シートがなければ作成し、そこにcsvデータを書き込んでいます。
 
 なお、引数の`--csv-path`はリポジトリからの相対パスでなければならないことに注意してください。

cli/msbird/README.md

@@ -75,7 +75,7 @@ The required option is `--config` and the required json key is as follows.
   // Access Token required to reference csv data from CLI to repository
   "gitHubAccessToken": "",
 
-  // The password that was set when the `sync.gs` was set up (if omitted, it is not necessary)
+  // The password that was set when the sync.gs was set up (if omitted, it is not necessary)
   "syncPassword": "",
 
   // Client Id created in Google API Console
@@ -123,7 +123,7 @@ The required options are `--config` and `--service-account`, and the json key re
   // Access Token required to reference csv data from CLI to repository
   "gitHubAccessToken": "",
 
-  // The password that was set when the `sync.gs` was set up (if omitted, it is not necessary)
+  // The password that was set when the sync.gs was set up (if omitted, it is not necessary)
   "syncPassword": ""
 }
 ```

examples/cli-config.json

@@ -1,10 +1,10 @@
 {
-    "syncUrl": "https://script.google.com/XXXXXXX/exec",
-    "repositoryUrl": "/~https://github.com/XXXXXXX/XXXXXXX",
-    "rootFolderId": "XXXXXXX",
-    "gitHubAccessToken": "",
-    "syncPassword": "",
-    "googleClientId": "XXXXXXX",
-    "googleClientSecret": "XXXXXXX",
-    "googleRefreshToken": "XXXXXXX"
-  }
+  "syncUrl": "https://script.google.com/XXXXXXX/exec",
+  "repositoryUrl": "/~https://github.com/XXXXXXX/XXXXXXX",
+  "rootFolderId": "XXXXXXX",
+  "gitHubAccessToken": "",
+  "syncPassword": "",
+  "googleClientId": "XXXXXXX",
+  "googleClientSecret": "XXXXXXX",
+  "googleRefreshToken": "XXXXXXX"
+}