Skip to content

Commit

Permalink
Update README and book
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillaume Bouvignies committed Jul 4, 2024
1 parent cbd4e52 commit c85c117
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Usage: buffrs <COMMAND>
Commands:
init Initializes a buffrs setup
new Creates a new buffrs package in the current directory
lint Check rule violations for this package
add Adds dependencies to a manifest file
remove Removes dependencies from a manifest file
Expand Down
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
* [buffrs update]()
* [Package Commands](commands/package-commands.md)
* [buffrs init](commands/buffrs-init.md)
* [buffrs new](commands/buffrs-new.md)
* [buffrs lint](commands/buffrs-lint.md)
* [buffrs package](commands/buffrs-package.md)
* [buffrs install](commands/buffrs-install.md)
Expand Down
21 changes: 21 additions & 0 deletions docs/src/commands/buffrs-new.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## buffrs init

Initializes a Buffrs project in a new folder created in the current directory.

### Synopsis

`buffrs new <NAME>`

`buffrs new --lib <NAME>`

`buffrs new --api <NAME>`

### Description

This command creates a new Buffrs project with the provided name by creating a
manifest file (`Proto.toml`) as well as `proto` and `proto/vendor` directories
in a new directory created at the current location.

By default, if no package type is provided, `impl` (implementation) will be
used. The meaning of this is described in [Package
Types](../guide/package-types.md).

0 comments on commit c85c117

Please sign in to comment.