@kokiito0926/pseudoalias 0.0.5 → 0.0.6

package/README.md

@@ -1,7 +1,7 @@
-## スードーエイリアス（pseudoalias）
+## pseudoalias
 
-スードーエイリアス（pseudoalias）を用いれば、擬似的なエイリアスを作成することができます。  
-.bashrcなどにエイリアスを書くよりも、JavaScriptのファイルにエイリアスを書けたほうが便利かと思いました。
+pseudoaliasは、擬似的なエイリアスを作成することができるコマンドラインのツールです。  
+.bashrcなどにエイリアスを書くよりも、JavaScriptでエイリアスを書けるようになるので、書きやすいような気がします。
 
 ## インストール
 
@@ -9,26 +9,68 @@
 $ npm install --global @kokiito0926/pseudoalias
 ```
 
-## 実行方法
+## 使用方法
+
+設定のファイルにエイリアスを記述します。
+
+```javascript
+export const greetings = async () => {
+	console.log("Hello, world!");
+};
+
+export const addition = async (one, two) => {
+	console.log(Number(one) + Number(two));
+};
+
+export const subtraction = async (one, two) => {
+	console.log(Number(one) - Number(two));
+};
+
+export const multiplication = async (one, two) => {
+	console.log(Number(one) * Number(two));
+};
+
+export const division = async (one, two) => {
+	console.log(Number(one) / Number(two));
+};
+```
+
+--configのオプションに設定のファイルを指定します。  
+そうしたら、定義されているエイリアスを実行することができます。
 
 ```bash
-$ pseudoalias --config ./example.js
 $ pseudoalias --config ./example.js greetings
 $ pseudoalias --config ./example.js addition 1 2
 $ pseudoalias --config ./example.js subtraction 2 1
 ```
 
+エイリアスを書かずに実行した場合、エイリアスの一覧が表示されます。
+
+```bash
+$ pseudoalias --config ./example.js
+```
+
+--registerのオプションを用いると、ホームディレクトリに設定のファイルが保存されます。  
+それ以降は、--configのオプションを用いなくても、定義されているエイリアスを実行することができます。
+
 ```bash
 $ pseudoalias --config ./example.js --register
-$ pseudoalias --unregister
 
 $ pseudoalias greetings
 $ pseudoalias addition 1 2
 $ pseudoalias subtraction 2 1
 ```
 
+--unregisterのオプションを用いると、ホームディレクトリから設定のファイルを削除します。
+
+```bash
+$ pseudoalias --unregister
+```
+
+下記のコマンドを.bashrcなどに追記すると、入力補完が効くようになります。
+
 ```bash
-$ complete -C "pseudoalias --config ./example.js --completion" -o default pseudoalias
+$ complete -C "pseudoalias --completion" -o default pseudoalias
 ```
 
 ## ライセンス

package/index.js

@@ -31,8 +31,7 @@
 // >> $ ./index.js addition 1 2
 // >> $ ./index.js --unregister
 
-import os from "node:os";
-import { minimist, fs, path, argv } from "zx";
+import { os, minimist, fs, path, argv } from "zx";
 import { pathToFileURL } from "node:url";
 
 const CONFIG_DIR = path.join(os.homedir(), ".pseudoalias");

package/package.json

@@ -1,8 +1,8 @@
 {
 	"name": "@kokiito0926/pseudoalias",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"private": false,
-	"description": "スードーエイリアス（pseudoalias）を用いれば、擬似的なエイリアスを作成することができます。",
+	"description": "擬似的なエイリアスを作成することができるコマンドラインのツールです。",
 	"keywords": [
 		"cli",
 		"bash",