Skip to content

Commit

Permalink
add a section about the configuration to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
amtoine committed Aug 19, 2023
1 parent 321ec27 commit 643c697
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ A fast *interactive explorer* tool for *structured data* inspired by [`nu-explor
- [*installing manually*](#installing-manually)
- [*using `nupm install`*](#using-nupm-install)
- [*usage*](#usage)
- [*configuration*](#configuration)
- [*see the documentation locally*](#see-the-documentation-locally)
- [*TODO*](#todo)

Expand Down Expand Up @@ -118,6 +119,17 @@ help explore
open Cargo.toml | explore
```

# configuration
the default configuration can be found in [`examples/configuration`](examples/configuration) and can
be tested as follows
```nushell
$nu | explore (
open examples/configuration/config.nuon
| insert colors (open examples/configuration/themes/dark.nuon)
| insert keybindings (open examples/configuration/keybindings.nuon)
)
```

# see the documentation locally
```nushell
cargo doc --document-private-items --no-deps --open
Expand Down

0 comments on commit 643c697

Please sign in to comment.