Skip to content

Commit 36a9883

Browse files
committed
Updated README.md and docs/src/core-concepts/flags.md. also: main.rs is moved to examples/taskr.rs as an example file (different code too). 0.3.0 commit
1 parent c13fcc2 commit 36a9883

2 files changed

Lines changed: 13 additions & 7 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515

1616
---
1717

18-
# Disclaimer
19-
vecli is currently in an unstable state, regarding its status as a new crate. The API is subject to change and the crate is experimental.
20-
I do not recommend using it in production.
18+
> [!WARNING]
19+
> vecli is currently in an unstable state, regarding its status as a new crate. The API is subject to change and the crate is experimental.
20+
> I do not recommend using it in production.
2121
2222
# What is vecli?
2323
vecli is a zero-dep CLI framework made in Rust with UX in mind, and makes development of CLI tools easy and straightforward.
@@ -38,9 +38,17 @@ Then vecli is perfect for you! If not? You're at the wrong place.
3838
- App-level strict flag mode
3939
- Main entry point for REPL-style usage
4040
- Interactive prompts built in: `Terminal`, `Confirm`, and `Choice`
41+
- Nested subcommands with recursive dispatch
42+
- Parent commands via `Command::parent()` for grouping without a handler
43+
- Per-command `print_help_if_no_args` support
4144

4245
## Documentation
43-
It's [here](https://docs.rs/vecli).
46+
The API reference is [here](https://docs.rs/vecli).
47+
48+
> [!NOTE]
49+
> The user guide is under construction. Expect the bare minimum for knowing vecli.
50+
51+
The user guide is [here](https://razkar-studio.github.io/vecli/).
4452

4553
# Usage
4654

@@ -71,7 +79,7 @@ fn main() {
7179
Run `cargo run hello`, and you should see `Hello!` printed to the console.
7280
Congrats, you've created your first CLI tool using vecli! Really, it's *that* easy.
7381

74-
For more details and features unseen in this README, check the [documentation](https://docs.rs/vecli).
82+
For more details and features unseen in this README, check the [documentation](https://docs.rs/vecli), or the [user guide](https://razkar-studio.github.io/vecli/).
7583

7684
# Installation
7785
To install vecli as a dependency, run the following command on your cargo project:

docs/src/core-concepts/flags.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,5 +71,3 @@ flag parsing before any command is dispatched.
7171
---
7272

7373
While making commands, you may have noticed that the function takes this peculiar argument: `&CommandContext`. What is that? Know more about the [CommandContext](./context.md) as our next stop.
74-
75-
If you've been this far from the beginning, congrats! This doc is under production and you've reached the end... for now. More guides will be added soon! For now, read the API reference at [docs.rs](https://docs.rs/vecli).

0 commit comments

Comments
 (0)