Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chouchouji committed Nov 10, 2024
1 parent 03384fc commit a80db43
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<img src="https://github.com/user-attachments/assets/723ef410-5dc0-46e6-966f-fa740107e856" alt="logo" style="background: red" />
<img src="https://github.com/user-attachments/assets/723ef410-5dc0-46e6-966f-fa740107e856" alt="logo" />
<h1>Alias Manager</h1>
<p>A tool used to manage your system aliases</p>
<p>
Expand All @@ -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.
Expand Down

0 comments on commit a80db43

Please sign in to comment.