update: version v0.0.3

d-tsuji · Apr 26, 2020 · f8d3303 · f8d3303
1 parent dffbd3e
commit f8d3303
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -4,40 +4,7 @@
 
 <img src="img/logo.png" width="300">
 
-Qiisync は Qiita への記事の投稿や更新に便利な CLI クライアントです。
-
-## インストール
-
-### Binary
-
-Binary が必要な場合は [Releases](https://github.com/d-tsuji/qiisync/releases) ページから欲しいバージョンの zip ファイルをダウンロードしてください。
-zip ファイルを解凍し、パスが通る場所に Binary を配置します。
-
-### macOS
-
-```
-$ brew tap d-tsuji/qiisync
-$ brew install qiisync
-```
-
-### CentOS
-
-```
-$ sudo rpm -ivh https://github.com/d-tsuji/qiisync/releases/download/v0.0.1/qiisync_0.0.1_Tux-64-bit.rpm
-```
-
-### Debian, Ubuntu
-
-```
-$ wget https://github.com/d-tsuji/qiisync/releases/download/v0.0.1/qiisync_0.0.1_Tux-64-bit.deb
-$ sudo dpkg -i qiisync_0.0.1_Tux-64-bit.deb
-```
-
-### Golang
-
-```
-$ go get -u github.com/d-tsuji/qiisync/cmd/qiisync
-```
+Qiisync は Qiita(https://qiita.com/) への記事の投稿や更新に便利な CLI クライアントです。
 
 ## 使い方
 
@@ -66,10 +33,10 @@ filename_mode = "title"
 
 #### [local]
 
-| #   | 項目            | 説明                                                                                                                                                                                               | デフォルト値 |
-| --- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
-| 1   | `base_dir`      | 記事を格納するパスのルートです。                                                                                                                                                                   | <必須>       |
-| 2   | `filename_mode` | 記事をローカルに取得する際のファイル名です。"title" か "id" を指定できます。<br>"title" はファイル名に、Qiita の記事のファイル名を、"id" の場合は記事のファイル名に Qiita の記事の ID を用います。 | "title"      |
+| #   | 項目            | 説明                                                                                                                                                                                                       | デフォルト値 |
+| --- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
+| 1   | `base_dir`      | 記事を格納するパスのルートです。                                                                                                                                                                           | <必須>       |
+| 2   | `filename_mode` | 記事をローカルに取得する際のファイル名です。`"title"` か `"id"` を指定できます。<br>`"title"` はファイル名に、Qiita の記事のファイル名を、`"id"` の場合は記事のファイル名に Qiita の記事の ID を用います。 | "title"      |
 
 ### 記事の操作
 
@@ -81,16 +48,16 @@ Qiisync では以下の 3 つの操作をサポートしています。
 
 #### 記事のダウンロード (qiisync pull)
 
-```bash
+```
 $ qiisync pull
 ```
 
 設定完了後、上記のコマンドで Qiita の記事を `base_dir` で指定したディレクトリ配下にダウンロードできます。
 
 `base_dir` を `"./testdata/output/pull"` に設定して `qiisync pull` を実行したときは以下のようにダウンロードされます。
-`base_dir` 配下に記事を作成した日付ごとにディレクトリが作成されて、その中に記事が保存されます。なお、同じ日付に同一記事のタイトルが複数存在する場合、2番目以降のファイルのタイトルには連番が付与されます。
+`base_dir` 配下に記事を作成した日付ごとにディレクトリが作成されて、その中に記事が保存されます。なお、同じ日付に同一記事のタイトルが複数存在する場合、2番目以降のファイルのタイトルには連番が自動的に付与されます。
 
-```bash
+```
 $ ./qiisync pull
      fresh remote=2020-04-14 11:26:38 +0900 JST > local=0001-01-01 00:00:00 +0000 UTC
      store /mnt/c/Users/dramt/go/src/github.com/d-tsuji/qiisync/testdata/output/pull/20200413/改行コードって難しいっ.md
@@ -105,7 +72,7 @@ $ ./qiisync pull
 
 `filename_mode` で `"id"` を指定しているとダウンロードしたときのファイル名は以下のようになります。
 
-```bash
+```
 $ ./qiisync pull
      fresh remote=2020-04-14 11:26:38 +0900 JST > local=0001-01-01 00:00:00 +0000 UTC
      store /mnt/c/Users/dramt/go/src/github.com/d-tsuji/qiisync/testdata/output/pull/20200413/1234567890abcdefghij.md
@@ -141,27 +108,27 @@ Private: false
 
 #### 記事の更新 (qiisync update)
 
-```bash
+```
 $ qiisync update <filepath>
 ```
 
 `qiisync update` を実行したときの実行例を記載します。`qiisync pull` でローカルにダウンロードしたメタデータが付与されているファイルを指定します。
 
-```bash
+```
 $ qiisync update ./testdata/output/pull/20200423/はじめてのGo.md
       post fresh article ---> https://qiita.com/tutuz/private/1234567890abcdefghij
 ```
 
 ファイルがリモートの記事よりも新しくない場合は、更新は行われません。ローカルファイルの更新日時と Qiita 上の記事の更新日時を比較して判定します。
 
-```bash
+```
 $ qiisync update ./testdata/output/pull/20200423/はじめてのGo.md
            article is not updated. remote=2020-04-23 13:34:50 +0900 JST > local=2020-04-23 13:33:10.8990083 +0900 JST
 ```
 
 #### 記事の投稿 (qiisync post)
 
-```bash
+```
 $ qiisync post <filepath>
 ```
 
@@ -186,12 +153,45 @@ true
      store /mnt/c/Users/dramt/go/src/github.com/d-tsuji/qiisync/testdata/output/pull/20200423/はじめてのGo.md
 ```
 
-## 制限事項
+## インストール
+
+### Binary
+
+Binary が必要な場合は [Releases](https://github.com/d-tsuji/qiisync/releases) ページから欲しいバージョンの zip ファイルをダウンロードしてください。
+zip ファイルを解凍し、パスが通る場所に Binary を配置します。
+
+### macOS
+
+```
+$ brew tap d-tsuji/qiisync
+$ brew install qiisync
+```
+
+### CentOS
+
+```
+$ sudo rpm -ivh https://github.com/d-tsuji/qiisync/releases/download/v0.0.3/qiisync_0.0.3_Tux-64-bit.rpm
+```
+
+### Debian, Ubuntu
+
+```
+$ wget https://github.com/d-tsuji/qiisync/releases/download/v0.0.3/qiisync_0.0.3_Tux-64-bit.deb
+$ sudo dpkg -i qiisync_0.0.3_Tux-64-bit.deb
+```
+
+### go get
+
+```
+$ go get -u github.com/d-tsuji/qiisync/cmd/qiisync
+```
+
+### 制限事項
 
-- Winodws 
+#### Winodws 
 
-Windows 環境でも動作しますが、今のところ Qiisync が Windows の改行コード CRLF(`\r\n`) をサポートしていないため、`qiisync post` でファイルを投稿する際のファイルの改行コードは LF(`\r`) である必要があります。
-また、`~/.config/qiisync/config` に記述する `base_dir` も `"testdata\\output\\pull\\"` といったように `\` をエスケープする必要があります。
+- Windows 環境でも動作しますが、今のところ Qiisync が Windows の改行コード CRLF(`\r\n`) をサポートしていないため、`qiisync post` でファイルを投稿する際のファイルの改行コードは LF(`\r`) である必要があります。
+- また、`~/.config/qiisync/config` に記述する `base_dir` も `"testdata\\output\\pull\\"` といったように `\` をエスケープする必要があります。
 
 ## ライセンス
 

diff --git a/version.go b/version.go
@@ -1,4 +1,4 @@
 package qiisync
 
 // Version is the version to be displayed in the command line help message.
-const Version = "0.0.2"
+const Version = "0.0.3"