Skip to content

Commit

Permalink
add a demo
Browse files Browse the repository at this point in the history
this commit also aligns the TOC
  • Loading branch information
amtoine committed Sep 9, 2023
1 parent 235a33e commit 0883d49
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@ A fast *interactive explorer* tool for *structured data* inspired by [`nu-explor

# table of content
- [*introduction*](#introduction)
- [*the idea behind an explorer*](#the-idea-behind-an-explorer)
- [*why not `nu-explore`?*](#why-not-nu-explore)
- [*the idea behind an explorer*](#the-idea-behind-an-explorer)
- [*why not `nu-explore`?*](#why-not-nu-explore)
- [*installation*](#installation)
- [*building from source*](#building-from-source)
- [*installing manually*](#installing-manually)
- [*using `nupm install` (recommended)*](#using-nupm-install-recommended)
- [*building from source*](#building-from-source)
- [*installing manually*](#installing-manually)
- [*using `nupm install` (recommended)*](#using-nupm-install-recommended)
- [*usage*](#usage)
- [*demo*](#demo)
- [*configuration*](#configuration)
- [*default configuration*](#default-configuration)
- [*an example*](#an-example)
- [*some convenience*](#-some-convenience)
- [*see the documentation locally*](#see-the-documentation-locally)
- [*contributing*](#contributing)
- [*TODO*](#todo)
- [*features*](#features)
- [*internal*](#internal)
- [*features*](#features)
- [*internal*](#internal)

# introduction
## the idea behind an *explorer*
Expand Down Expand Up @@ -109,6 +110,9 @@ help nu_plugin_explore
open Cargo.toml | nu_plugin_explore
```

## demo
![simple demo][examples/demo.mp4]

# configuration
## default configuration
you can find it in [`default.nuon`](./examples/config/default.nuon).
Expand Down
Binary file added examples/demo.mp4
Binary file not shown.

0 comments on commit 0883d49

Please sign in to comment.