Skip to content

Commit a80db43

Browse files
committed
docs: update readme
1 parent 03384fc commit a80db43

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="https://github.com/user-attachments/assets/723ef410-5dc0-46e6-966f-fa740107e856" alt="logo" style="background: red" />
2+
<img src="https://github.com/user-attachments/assets/723ef410-5dc0-46e6-966f-fa740107e856" alt="logo" />
33
<h1>Alias Manager</h1>
44
<p>A tool used to manage your system aliases</p>
55
<p>
@@ -20,14 +20,40 @@
2020

2121
### Create Alias
2222

23+
You can create a new alias.
24+
25+
> [!TIP]
26+
> Please ensure that you have understood how to create a right alias.
27+
> Don't allow to add `duplicate` alias.
28+
29+
![create-alias](https://github.com/user-attachments/assets/29caefb6-fcbc-4324-b4a6-d3a8d6d30d82)
30+
2331
### Rename Alias
2432

33+
It supports rename an alias.
34+
35+
![rename-alias](https://github.com/user-attachments/assets/1bd4e199-5476-4d8e-b126-7a62d5b35201)
36+
2537
### Delete Alias(es)
2638

39+
It supports delete all aliases or one alias.
40+
41+
![delete-alias](https://github.com/user-attachments/assets/c61cd617-526b-45fb-9cf5-78d7eecbaa4e)
42+
2743
### Run Alias
2844

45+
Click `run` button, it will activate terminal and exec that command.
46+
47+
If the terminal shows error like `command not found`, close terminal and try again.
48+
49+
![run-alias](https://github.com/user-attachments/assets/eb0cda22-cea0-4eed-a8d5-100a2a95a66b)
50+
2951
### Set Store Path
3052

53+
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`
54+
55+
![store-path](https://github.com/user-attachments/assets/5508beeb-1983-45d9-bbcd-4a0201205a23)
56+
3157
## Feedback
3258

3359
If you encounter problems or have good ideas and suggestions, please [report](https://github.com/chouchouji/alias-manager/issues) here.

0 commit comments

Comments
 (0)