From a80db430bf5d23671d35987d4175a3a46434dfd9 Mon Sep 17 00:00:00 2001 From: chouchouji <1305974212@qq.com> Date: Sun, 10 Nov 2024 14:46:02 +0800 Subject: [PATCH] docs: update readme --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e80cf8b..7a36ba0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- logo + logo

Alias Manager

A tool used to manage your system aliases

@@ -20,14 +20,40 @@ ### Create Alias +You can create a new alias. + +> [!TIP] +> Please ensure that you have understood how to create a right alias. +> Don't allow to add `duplicate` alias. + +![create-alias](https://github.com/user-attachments/assets/29caefb6-fcbc-4324-b4a6-d3a8d6d30d82) + ### Rename Alias +It supports rename an alias. + +![rename-alias](https://github.com/user-attachments/assets/1bd4e199-5476-4d8e-b126-7a62d5b35201) + ### Delete Alias(es) +It supports delete all aliases or one alias. + +![delete-alias](https://github.com/user-attachments/assets/c61cd617-526b-45fb-9cf5-78d7eecbaa4e) + ### Run Alias +Click `run` button, it will activate terminal and exec that command. + +If the terminal shows error like `command not found`, close terminal and try again. + +![run-alias](https://github.com/user-attachments/assets/eb0cda22-cea0-4eed-a8d5-100a2a95a66b) + ### Set Store Path +The default store path is `${homedir}/.zshrc`, like `/Users/xxx/.zshrc`. If you want to custom your alias store path, modify it by `Setting/Extensions/Alias Manager` + +![store-path](https://github.com/user-attachments/assets/5508beeb-1983-45d9-bbcd-4a0201205a23) + ## Feedback If you encounter problems or have good ideas and suggestions, please [report](https://github.com/chouchouji/alias-manager/issues) here.