Skip to content

Commit 0542ea0

Browse files
authored
Fix up README (#361)
* Fix up README
1 parent 9a050cd commit 0542ea0

1 file changed

Lines changed: 20 additions & 35 deletions

File tree

README.md

Lines changed: 20 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,19 @@
1717
#
1818
-->
1919

20-
# OpenWhisk Command Line Interface `wsk`
20+
# OpenWhisk Command-line Interface `wsk`
2121

22-
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
2322
[![Build Status](https://travis-ci.org/apache/incubator-openwhisk-cli.svg?branch=master)](https://travis-ci.org/apache/incubator-openwhisk-cli)
23+
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
24+
[![Join Slack](https://img.shields.io/badge/join-slack-9B69A0.svg)](http://slack.openwhisk.org/)
25+
[![Twitter](https://img.shields.io/twitter/follow/openwhisk.svg?style=social&logo=twitter)](https://twitter.com/intent/follow?screen_name=openwhisk)
26+
27+
OpenWhisk Command-line Interface (CLI) is a unified tool that
28+
provides a consistent interface to interact with OpenWhisk services.
2429

2530
# Where to download the binary of OpenWhisk CLI
2631

27-
The OpenWhisk CLI is available on the release page: [click here to
28-
download](https://github.com/apache/incubator-openwhisk-cli/releases). We
32+
The OpenWhisk CLI is available on the [releases page](https://github.com/apache/incubator-openwhisk-cli/releases). We
2933
currently have binaries available for Linux, Mac OS and Windows under i386 and
3034
amd64 architectures. Linux versions are also available under Linux on Z, Power
3135
and 64-bit ARM architectures. You can download the binary, which fits your
@@ -36,16 +40,15 @@ local environment.
3640
The OpenWhisk CLI is written in the Go language. You have two options to build
3741
the binary locally:
3842

39-
1. Build using the packaged Gradle scripts (including the 'gogradle' plugin),
40-
now the preferred build method.
41-
2. Compile in your local Go environment,
43+
1. Build using the packaged Gradle scripts (including the 'gogradle' plugin) now the preferred build method.
44+
2. Compile in your local Go environment
4245

4346
## Build the binary with Gradle
4447

4548
**Note:** For those who may have used the Gradle build previously, it has been
4649
re-engineered to no longer required Docker or Go to be pre-installed on your
4750
system. Using the [gogradle](https://github.com/gogradle/gogradle) plugin,
48-
Gradle now uses a prexisting Go environment to build if it can be located, or
51+
Gradle now uses a preexisting Go environment to build if it can be located, or
4952
downloads and installs an environment within the build directory.
5053

5154
To build with Gradle, open an terminal, go to the directory of OpenWhisk CLI
@@ -104,8 +107,7 @@ functional OpenWhisk environment.
104107

105108
## Compile the binary using your local Go environment
106109

107-
Make sure that you have Go installed [installing
108-
Go](https://golang.org/doc/install), and `$GOPATH` is defined [Go development
110+
Make sure that you have [Go installed](https://golang.org/doc/install), and `$GOPATH` is defined in your [Go development
109111
environment](https://golang.org/doc/code.html).
110112

111113
Then download the source code of the OpenWhisk CLI and the dependencies by
@@ -125,7 +127,7 @@ $ go get -u github.com/jteeuwen/go-bindata/...
125127
$ go-bindata -pkg wski18n -o wski18n/i18n_resources.go wski18n/resources
126128
```
127129

128-
Unfortunately, it has become necessary to lock dependencies versions to obtain a
130+
It is necessary to lock dependencies versions to obtain a
129131
clean build of wsk. To that end, it's now necessary to populate the `vendors`
130132
folder using the versions selected in the `vendor/vendor.json`:
131133

@@ -141,8 +143,8 @@ $ go build -o wsk
141143
```
142144

143145
If you would like to build the binary for a specific operating system, you may
144-
add the arguments GOOS and GOARCH into the Go build command. GOOS can
145-
be set to "linux" "darwin" or "windows".
146+
add the arguments `GOOS` and `GOARCH` into the Go build command. `GOOS` can
147+
be set to `linux`, `darwin`, or `windows`.
146148

147149
For example, run the following command to build the binary for Linux:
148150

@@ -163,33 +165,16 @@ command help, execute the following command:
163165
$ wsk --help
164166
```
165167

166-
To get CLI command debug information, include the -d, or --debug flag when
168+
To get CLI command debug information, include the `-d`, or `--debug` flag when
167169
executing this command.
168170

169171
# Continuous Integration
170172

171-
In order to build OpenWhisk CLI binaries with good quality, OpenWhisk CLI uses
172-
Travis CI as the continuous delivery service for Linux and Mac. OpenWhisk CLI is
173-
a Go project. Currently Travis CI supports the environments of Linux and Mac,
173+
Travis CI is used as a continuous delivery service for Linux and Mac.
174+
Currently Travis CI supports the environments of Linux and Mac,
174175
but it is not available for Windows. We will add support of AppVeyor CI in
175-
future to run the test cases and build the binary for Windows.
176+
future to run test cases and build the binary for Windows.
176177

177178
# Disclaimer
178179

179-
Apache OpenWhisk Command Line Interface(CLI) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
180-
181-
This project is currently on an experimental stage. We periodically synchronize
182-
the source code and test cases of this repository with the [CLI
183-
folder](https://github.com/apache/incubator-openwhisk/tree/master/tools/cli/go-whisk-cli)
184-
and the [test
185-
folder](https://github.com/apache/incubator-openwhisk/tree/master/tests) in
186-
OpenWhisk. The framework of test cases is under construction for this
187-
repository. Please contribute to the [CLI
188-
folder](https://github.com/apache/incubator-openwhisk/tree/master/tools/cli/go-whisk-cli)
189-
in OpenWhisk for any CLI changes, before we officially announce the separation
190-
of OpenWhisk CLI from OpenWhisk.
191-
192-
The OpenWhisk Command Line Interface (OpenWhisk CLI) is a unified tool that
193-
provides a consistent interface to interact with OpenWhisk services. With this
194-
tool to download and configure, you are able to manage OpenWhisk services from
195-
the command line and automate them through scripts.
180+
Apache OpenWhisk Command-line Interface (CLI) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

0 commit comments

Comments
 (0)