README.md in japanese_local_governments-0.1.0 vs README.md in japanese_local_governments-0.2.0
- old
+ new
@@ -8,10 +8,14 @@
このツールでは、各地方自治体のコードを調べたり、コードに対応する自治体の情報を得ることができます。
また、都道府県、自治体名のあるCSVファイルにコードを付加することもできます。
これらの機能をライブラリとして提供するとともに、コマンドラインツールとしても利用できます。
+次のコマンドで本ツールの持つ地方自治体のデータがすべて出力されます。
+
+ $ jlg list
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -71,10 +75,11 @@
`jlg list` を実行すると、本ツールが持つ全てのデータを標準出力に出力します。
出力する文字エンコーディングは UTF-8です。
`-o` オプションを利用すると、指定したファイルに結果を出力します。
`-p` オプションを利用すると、都道府県のみのデータを出力します。
+`-s` オプションを利用すると ShiftJISでファイルを出力します。(`-o` オプションと同時に使った場合のみ有効)
#### 使用例
$ jlg list
code,pref,name,type,district,furigana
010006,北海道,北海道,都道府県,北海道地方,ほっかいどう
@@ -89,11 +94,11 @@
### add_code
都道府県名、自治体名を表すカラムを持つCSVファイルに 自治体コードをカラムを追加します。
入力ファイルとしては次のようなファイルを用意します。
-1行目はカラムヘッダである必要があります。都道府県名を表すカラムは pref、自治体名を表すカラムは name というカラム名にします。
+1行目はカラムヘッダである必要があります。デフォルトでは pref を都道府県名を表すカラム、name を自治体名を表すカラムとして処理します。
pref,name,type,district,furigana
北海道,北海道,都道府県,北海道地方,ほっかいどう
北海道,札幌市,政令市,北海道地方,さっぽろし
北海道,札幌市中央区,行政区,北海道地方,さっぽろしちゅうおうく
@@ -105,15 +110,20 @@
010006,北海道,北海道,都道府県,北海道地方,ほっかいどう
011002,北海道,札幌市,政令市,北海道地方,さっぽろし
011011,北海道,札幌市中央区,行政区,北海道地方,さっぽろしちゅうおうく
011029,北海道,札幌市北区,行政区,北海道地方,さっぽろしきたく
-`-o` オプションを利用すると、出力ファイル名を指定することができます。
-このオプションがない場合、入力ファイル名に実行日付が付加されたファイル名で出力します。
+`-o` オプションを利用すると、出力ファイル名を指定することができます。このオプションがない場合、入力ファイル名に実行日付が付加されたファイル名で出力します。
+`-p`,`-n` オプションを利用すると都道府県名と自治体名を表すカラム名を指定することができます。
+`-s` オプションを利用するとShiftJISで作成されたCSVファイルを処理できます。
#### 使用例
$ jlg add_code 自治体データ.csv #=> 自治体データ_20160207.csv という名前のファイルに出力される
$ jlg add_code 自治体データ.csv -o 自治体データ_コード付き.csv #=> 自治体データ_コード付き.csv という名前のファイルに出力される
+
+ $ jlg add_code 自治体データ.csv -o 自治体データ_コード付き.csv -p 都道府県 -n 自治体名 #=> 自治体データ_コード付き.csv という名前のファイルに出力される。都道府県、自治体名のカラム名を指定しています。
+
+ $ jlg add_code 自治体データ_sjis.csv -s #=> ShiftJISで作成されたCSVファイル 自治体データ_sjis.csv を読み込んで ShiftJIS で出力します。
### help
$ jlg help [COMMAND] # Describe available commands or one specific command