Skip to content

Commit

Permalink
docs: Wording change in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ysthakur committed Aug 14, 2023
1 parent c1082d0 commit 901c0a7
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
Expand Up @@ -6,7 +6,7 @@
[![License](https://img.shields.io/crates/l/man-completions.svg)](./LICENSE.md)

This is an unfinished project to parse manpages to get completions for Zsh, Bash,
Nushell, and other shells. Bash is still a work in progress.
Nushell, and, in the future, other shells. Bash is still a work in progress.

It also generates JSON files, in case your shell isn't supported, so you can process
it and generate completions yourself.
Expand All @@ -25,8 +25,13 @@ I will eventually get around to porting Fish's subcommand detection.
## Installation

- Using Cargo: `cargo install man-completions`
- As a Nix flake: I have no idea
- Download the right executable for your platform from the latest [release](https://github.com/ysthakur/man-completions/releases)
- From the [Releases](https://github.com/ysthakur/man-completions/releases) page:
Simply download the right executable for your platform from the latest release
- As a Nix flake: `github:ysthakur/man-completions`
- Untested because I have no idea how to install packages that are flakes
- Build it yourself:
- Download this repository (`git clone [email protected]:ysthakur/man-completions.git`)
- `cd man-completions && cargo build --release`

## Flags

Expand Down

0 comments on commit 901c0a7

Please sign in to comment.