Skip to content

Commit 9a83c88

Browse files
author
Joshua Anderson
committed
docs(client-go): update readme
1 parent b90c2fb commit 9a83c88

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

client-go/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
# Deis Client
22

3-
`deis` is a command line utility used to interact with a Deis Cluster.
3+
`deis` is a command line utility used to interact with the [Deis](http://deis.io) open source PaaS.
44

5-
This is a WIP rewrite of the client in go.
5+
Please add any [issues](https://github.com/deis/deis/issues) you find with this software to
6+
the [Deis Project](https://github.com/deis/deis).
7+
8+
## Installation
9+
10+
Currently the only way to use the go version of the `deis` client is to build it yourself.
11+
To build the `deis` client, you need to have [go](https://golang.org/), [Godep](https://github.com/tools/godep),
12+
and [make](https://www.gnu.org/software/make/) installed. Then run `make build`.
13+
14+
## Usage
15+
16+
Running `deis help` will give you a up to date list of `deis` commands.
17+
To learn more about a command run `deis help <command>`.
18+
19+
## Windows Support
20+
21+
`deis` has experimental support for Windows. To build deis for Windows, you need to install
22+
[go](https://golang.org/) and [Godep](https://github.com/tools/godep). Then run the `make.bat` script.
623

724
## License
825

0 commit comments

Comments
 (0)