Skip to content

Commit

Permalink
Add quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
barthr committed Apr 1, 2022
1 parent 9578732 commit df608bc
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ interactive way combine multiple commands from history in a single command.
* [Installation](#installation)
* [Prebuilt binaries](#prebuilt-binaries)
* [Install from source](#install-from-source)
* [Quickstart](#quickstart)
* [Configuration](#configuration)
* [Roadmap](#roadmap)
* [Acknowledgements](#acknowledgements)
Expand Down Expand Up @@ -38,6 +39,15 @@ tar -xf <downloaded_archive> redo && sudo mv redo /usr/local/bin
go install github.com/barthr/redo@latest
```

## Quickstart

redo contains a couple of commands, which can be used to create reusable functions.

1. `redo` - Opens up the interactive window to create a new function
2. `redo alias-file` - Prints the path to the functions file
3. `redo edit` - Opens the functions file in your configured editor
4. `redo help` - Prints a help message which includes information about all the commands

## Configuration

Redo can mostly run without requiring any specific configuration, however it is possible to customize this configuration
Expand Down

0 comments on commit df608bc

Please sign in to comment.