README書いた

README.md

@@ -0,0 +1,43 @@
+# skkeleton
+
+SKKの試作品です。名前は骨組みしかないSKKからの連想です。
+
+[denops.vim](https://github.com/vim-denops/denops.vim)を使用しているため導入が必要です。
+プラグイン内部に情報を持たないでどこまで作れるかというコンセプトで作成したためSKKとは動作が一部分違います。 また、自分が使用しない機能は実装していません。
+
+試作品故メンテナンスはしません。
+
+- Vimのマッピングを利用して仮名入力を行っているため細かい挙動が本家と違います
+  - `feedkeys()`を多用しているためバグが潜んでいる可能性が高いです
+- 実装を減らすためにユーザー辞書の形式としてJSONを採用しています
+- 変換の情報を全てバッファに格納しているため挙動が異なります
+- 片仮名変換は可能ですが片仮名モードはありません、入力してから変換してください
+- 候補が多い場合に出現するセレクタは実装していません
+
+# ライセンス
+
+zlib
+
+# 要件
+
+Deno 1.12.1及び[email protected]でテストをしています。
+
+比較的新しい機能を使用しているため、Vimの場合8.2.1978以降でしか動きません。
+
+# 設定
+
+`g:skkeleton#global_jisyo`でグローバル辞書のパスを指定できます(デフォルト:`/usr/share/skk/SKK-JISYO.L`)
+
+`g:skkeleton#global_jisyo_encoding`でグローバル辞書のエンコーディングを指定できます(デフォルト:`euc-jp`)
+
+`g:skkeleton#user_jisyo`でユーザー辞書のパスを指定できます(デフォルト:`~/.skke-jisyo.json`)
+
+# 使い方
+
+`<C-j>`で有効に、`l`で無効にできます。
+
+操作キーは基本的に本家準拠です(ハードコーディングしています)
+
+# 謝辞
+
+大幅に[eskk.vim](https://github.com/tyru/eskk.vim)の実装を参考にさせて頂いた他、テーブルをお借りしました。ありがとうございます。