Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update examples in README #113

Merged
merged 2 commits into from
Jun 14, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,13 @@ commands:
test:
desc: Run the tests
run: script/test

lint:
desc: Lint the project
run: script/lint

open:
staging: https://staging.myapp.com
doc: https://godoc.org/github.com/org/myapp
```
See DevBuddy own [dev.yml](dev.yml)

Expand All @@ -121,14 +124,24 @@ Usage:
bud [command]

Available Commands:
cd Jump to a local project
clone Clone a project from github.com
create Create a new project
godoc Custom: Starting GoDoc server on http://0.0.0.0:6060
help Help about any command
lint Custom: Lint the project
test Custom: Run tests
up Ensure the project is up and running
cd Jump to a local project
ci Custom: Run all tests as CI would do
clone Clone a project from github.com
create Create a new project
godoc Custom: Starting GoDoc server on http://0.0.0.0:6060
help Help about any command
inspect Inspect the project and its tasks
install-dev Custom: Install bud in the GOROOT
install-release Custom: Remove all bud binaries and install a released version
integration Custom: Run the integration tests
lint Custom: Lint the project
lint-shell Custom: Lint the shell scripts
open Open a link about your project
release Custom: Create a new release (bud release [VERSION])
test Custom: Run the unittests
testup Custom: Build, install and run the development version
up Ensure the project is up and running
upgrade [experimental] Upgrade DevBuddy to the latest available release.

Flags:
-h, --help help for bud
Expand Down