Skip to content
This repository has been archived by the owner on Oct 23, 2019. It is now read-only.

Commit

Permalink
add usage to README
Browse files Browse the repository at this point in the history
  • Loading branch information
florimondmanca committed Apr 16, 2019
1 parent f93aa66 commit fcb427e
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

[pypi-url]: https://pypi.org/project/bocadillo-cli

Bocadillo CLI provides standard development tooling for [Bocadillo] projects.
Bocadillo CLI provides standard development tooling for [Bocadillo].

[bocadillo]: https://github.com/bocadilloproject/bocadillo

Expand All @@ -20,7 +20,34 @@ pip install bocadillo-cli

## Usage

> TODO
### Overview

```
$ bocadillo --help
Usage: bocadillo [OPTIONS] COMMAND [ARGS]...
Options:
-V, --version Show the version and exit.
--help Show this message and exit.
Commands:
create Initialize a Bocadillo project.
```

### Create a project

```
$ bocadillo create --help
Usage: bocadillo create [OPTIONS] NAME
Initialize a Bocadillo project.
Options:
-d, --directory DIRECTORY Directory where the project should be created.
Created if does not exist. Defaults to `NAME`.
--dry Dry mode: does not write anything.
--help Show this message and exit.
```

## Contributing

Expand Down

0 comments on commit fcb427e

Please sign in to comment.