Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Add workflow status badge.
Update paragraphs.
  • Loading branch information
alexesprit committed Mar 23, 2020
1 parent fd47254 commit 7f398a8
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# alias
# alias ![Test status][workflowBadge]

View and set command aliases in Windows.

## How to setup?
## Setup

Just cd in `alias` dir and run `alias`. It will ask you for installation if neccessary.

By default aliases are stored in `%USERPROFILE%\Documents\Scripts\Aliases`. You can set the directory to store aliases by changing the environment variable called `%ALIASES_DIR%`.

## Managing aliases

Get the list of available aliases:
```cmd
> alias
Expand Down Expand Up @@ -44,6 +46,7 @@ Deleted test
```

## Environment variables

`alias` changes two variables:
1. `%ALIASES_DIR%`
Directory where aliases are stored.
Expand All @@ -52,4 +55,6 @@ Adds `%ALIASES_DIR%` to `%PATH%`.

## License

Licensed under [MIT License](LICENSE.md).
This project is licensed under the [MIT License](LICENSE.md).

[workflowBadge]: https://img.shields.io/github/workflow/status/alexesprit/alias/Test?label=Test

0 comments on commit 7f398a8

Please sign in to comment.