README.rdoc in jp_address-0.0.2 vs README.rdoc in jp_address-0.0.3
- old
+ new
@@ -1,14 +1,17 @@
= JpAddress: A Rails plugin for Japan Zipcode API.
== JpAddressとは
日本郵便の「郵便番号データ」を Rails 4.0 で使用するためのプラグインです。
-以下の機能を備えます。
+以下の機能を提供します。
-* 郵便局提供の郵便番号データをダウンロードしてDBにロード
+* 郵便局提供の郵便番号データをダウンロードしてDBにロードするメソッド。
* 郵便番号をキーに住所情報を返却するAPI(コントローラ)。
+要するに、「郵便番号検索 ruby gem」でググった人向けの gem です。
+お使いのRailsアプリケーションにマウントして使えますので、後必要なのは戻ってくるJSONを加工する手順だけです。
+
== インストール
% gem install jp_address
GemFileに追記
gem 'jp_address'
@@ -24,9 +27,10 @@
% rails runner -e production 'JpAddress::Zipcode.load_master_data'
環境にもよりますが、1~3分ぐらいかかると思います。
※ APP_ROOT/tmp/ を作業ディレクトリに使用しています。
+※ 最初にテーブルをトランケートしますので、毎回「全件insert」になります。
== APIのマウント
マウントしたいRailsアプリの config/routes.rb に追記。
mount JpAddress::Engine, at: "/jp_address"