Skip to content

Commit f381484

Browse files
committed
Add current-crate example to the README
1 parent 1b11233 commit f381484

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,23 @@ tokio::sync:
6464
...
6565
```
6666

67+
Run with no arguments from inside a Rust project to see the current crate's public API:
68+
69+
```
70+
$ grox
71+
72+
crate groxide
73+
74+
modules:
75+
cli
76+
error
77+
78+
functions:
79+
pub fn run(cli: &cli::Cli) -> error::Result<()> Runs the groxide CLI with the given parsed arguments.
80+
```
81+
82+
Add `-r` for the full recursive listing of everything public in the crate.
83+
6784
It works outside a project too. Standard library queries and crates.io auto-fetch need no `Cargo.toml`:
6885

6986
```
@@ -126,6 +143,10 @@ npx skills add jhartquist/groxide
126143
## Usage
127144

128145
```sh
146+
# Current crate overview (run inside a Rust project)
147+
grox
148+
grox -r # full recursive listing of the current crate
149+
129150
# Method docs
130151
grox tokio::sync::Mutex::lock
131152

0 commit comments

Comments
 (0)