Skip to content

Commit

Permalink
Add synopsis
Browse files Browse the repository at this point in the history
  • Loading branch information
mara-schulke committed Aug 16, 2023
1 parent 64a771d commit 2c8844f
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,31 @@ Useful resources:

- [The Buffrs Book](https://helsing-ai.github.io/buffrs)
- [Crate Documentation](https://docs.rs/buffrs)
- `buffrs help`

## Synopsis

```
An opinionated protobuf package manager
Usage: buffrs <COMMAND>
Commands:
init Initializes a buffrs setup
add Adds dependencies to a manifest file
remove Removes dependencies from a manifest file
publish Packages and uploads this api to the registry
install Installs dependencies
uninstall Uninstalls dependencies
generate Generate code from installed buffrs packages
login Logs you in for a registry
logout Logs you out from a registry
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```

## Motivation

Expand Down

0 comments on commit 2c8844f

Please sign in to comment.