Skip to content

Commit

Permalink
Bump Cargo.toml to version 0.1.6 and add missing docs to README
Browse files Browse the repository at this point in the history
  • Loading branch information
lucperkins committed Oct 5, 2023
1 parent 98e4d45 commit 3b18170
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fh"
version = "0.1.5"
version = "0.1.6"
authors = ["Determinate Systems <[email protected]>"]
edition = "2021"
license = "Apache 2.0"
Expand Down
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Respond to the prompts it provides you and at the end `fh` will write a `flake.n

`fh init` has built-in support for the following languages:

* [Elm]
* [Go]
* [Java]
* [JavaScript]
Expand Down Expand Up @@ -165,7 +166,6 @@ fh list flakes
...
```


#### List orgs

```shell
Expand Down Expand Up @@ -203,6 +203,50 @@ fh list versions hyprwm/Hyprland "0.1.*"
+------------------------------------------------------------------------------------------------------------------------------+
```

### List by label

You can list flakes by label using the `fh list label` comand:

```shell
fh list label <label>
```

Here's an example:

```shell
fh list label wayland
```

```console
+-------------------------------------------------------------+
| Flake FlakeHub URL |
+-------------------------------------------------------------+
| hyprwm/Hyprland https://flakehub.com/flake/hyprwm/Hyprland |
+-------------------------------------------------------------+
```

## Shell completion

You can generate shell completion scripts using the `fh completion` command:

```shell
fh completion <shell>
```

Here's an example:

```shell
fh completion bash
```

These shells are supported:

* [Bash]
* [Elvish]
* [Fish]
* [Powershell]
* [zsh]

## A note on automation

Piping `fh list` commands to another program emits [CSV] instead of the stylized table.
Expand All @@ -217,7 +261,11 @@ You can apply the `--json` flag to each list command to produce JSON output.

For support, email [email protected] or [join our Discord](https://discord.gg/invite/a4EcQQ8STr).

[bash]: https://gnu.org/software/bash
[csv]: https://en.wikipedia.org/wiki/Comma-separated_values
[elm]: https://elm-lang.org
[elvish]: https://elv.sh
[fish]: https://fishshell.com
[flakehub]: https://flakehub.com
[flakes]: https://flakehub.com/flakes
[go]: https://golang.org
Expand All @@ -229,8 +277,10 @@ For support, email [email protected] or [join our Discord](https://discord.gg
[nixpkgs]: https://zero-to-nix.com/concepts/nixpkgs
[orgs]: https://flakehub.com/orgs
[php]: https://php.net
[powershell]: https://learn.microsoft.com/powershell
[python]: https://python.org
[ruby]: https://ruby-lang.org
[rust]: https://rust-lang.org
[semver]: https://flakehub.com/docs#semver
[zig]: https://ziglang.org
[zsh]: https://zsh.org

0 comments on commit 3b18170

Please sign in to comment.