From fcb427e8b58d47b923d8b1d0a09798aa9e55fdb5 Mon Sep 17 00:00:00 2001 From: florimondmanca Date: Wed, 17 Apr 2019 01:21:59 +0200 Subject: [PATCH] add usage to README --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 32a8cf2..bc05d6d 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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