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.

Sign up for GitHub

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

Added user steps to readme #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added user steps to readme #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# koku-cli

This repository serves as a place to create and upload releases of Koku-CLI. The `.travis.yml` file uses the [koku-cli-generator](https://github.com/project-koku/koku-cli-generator/). The travis build is triggered via webhook.

To get started using Koku-CLI:
1. Download and unzip the latest release for your API client from https://github.com/project-koku/koku-cli/releases.
2. Navigate to the `koku-cli-git` directory and make the `.client.sh` script executable.
3. Run your commands from the directory which contains the `.client.sh` script.