From 184ce5cccbea4c5e0fc953731772166391cd46e3 Mon Sep 17 00:00:00 2001 From: Bo Yang Date: Mon, 14 Nov 2016 10:52:07 -0800 Subject: [PATCH 1/2] add more information to README --- README.md | 48 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 36 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 7ea8316..24952a1 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ # Bluemix CLI -This is the command line for [Bluemix](https://console.ng.bluemix.net/). See help of each command [here](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html) or by running `bluemix help`. -# Getting started +This is the command line client for [Bluemix](https://console.ng.bluemix.net/). See help of each command from [Bluemix Docs](https://console.ng.bluemix.net/docs/cli/reference/bluemix_cli/index.html) or by running `bluemix help`. -Download and run the installer for your platform from [Download](#Download) section. +## Getting started + +Download and run the installer for your platform from [Downloads](#downloads) section. Once installed, you can login and interact with Bluemix ``` -$ bx api https://api.ng.bluemix.net +$ bluemix api https://api.ng.bluemix.net Setting api endpoint to https://api.ng.bluemix.net... OK -$ bx login +$ bluemix login API endpoint: https://api.ng.bluemix.net Email> xxxx@xxx.xxx.xxx @@ -20,24 +21,47 @@ Password> Authenticating... OK -$ bx list +$ bluemix list -Getting resources in org 'boyang@cn.ibm.com' / space 'ben' as xxxx@xxx.xxx.xxx... +Getting resources in org 'myorg' / space 'dev' as xxxx@xxx.xxx.xxx... ... ``` -Check our [plugin repository](http://plugins.ng.bluemix.net/ui/repository.html#bluemix-plugins) for any extension that enahnce our CLI capability. -# Download +## Downloads You can download the latest installers below. | **macOS** | **Linux 64 bit** | **Windows 64 bit** | |-----------|------------------|--------------------| | [Bluemix_CLI.pkg](http://public.dhe.ibm.com/cloud/bluemix/cli/bluemix-cli/Bluemix_CLI.pkg) | [Bluemix_CLI_amd64.tar.gz](http://public.dhe.ibm.com/cloud/bluemix/cli/bluemix-cli/Bluemix_CLI_amd64.tar.gz) | [Bluemix_CLI_amd64.exe](http://public.dhe.ibm.com/cloud/bluemix/cli/bluemix-cli/Bluemix_CLI_amd64.exe) | -# Changelog + +32 bit releases and previous releases can be found [here](./CHANGELOG.md) + +## Extending with plugins + +Check [plugin repository](http://plugins.ng.bluemix.net/ui/repository.html#bluemix-plugins) for any extension that enahnce the CLI capabilities. + + +To list the plugins in Bluemix CLI plugin repo: + +``` +bluemix plugin repo-plugins + +``` + +To download and install the plugin: + +``` +bluemix plugin install PLUGIN_NAME -r Bluemix + +``` + +## Release notes + Please refer to [here](./CHANGELOG.md) for details. -# Issues and defects -Any issue or defect, please [report in this GIT project repository](https://github.com/IBM-Bluemix/bluemix-cli-release/issues). \ No newline at end of file +# Issues, defects and feature requests + +Any issues/defects, or feature requests, please [file an issue](https://github.com/IBM-Bluemix/bluemix-cli-release/issues) if not raised before. \ No newline at end of file From fccd12df5211c30c248ac2e29b8232991727a063 Mon Sep 17 00:00:00 2001 From: Bo Yang Date: Mon, 14 Nov 2016 11:45:10 -0800 Subject: [PATCH 2/2] revise changelog --- CHANGELOG.md | 4 ---- README.md | 8 ++++---- 2 files changed, 4 insertions(+), 8 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index dadaac6..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,4 +0,0 @@ -# 0.4.4 (2016-11-08) -- Add 'org-user-remove' command to remove a user completely from an organization -- Upgrade CLI framework -- Upgrade to Go lang 1.7.3 \ No newline at end of file diff --git a/README.md b/README.md index 24952a1..4d3b77e 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,14 @@ You can download the latest installers below. | [Bluemix_CLI.pkg](http://public.dhe.ibm.com/cloud/bluemix/cli/bluemix-cli/Bluemix_CLI.pkg) | [Bluemix_CLI_amd64.tar.gz](http://public.dhe.ibm.com/cloud/bluemix/cli/bluemix-cli/Bluemix_CLI_amd64.tar.gz) | [Bluemix_CLI_amd64.exe](http://public.dhe.ibm.com/cloud/bluemix/cli/bluemix-cli/Bluemix_CLI_amd64.exe) | -32 bit releases and previous releases can be found [here](./CHANGELOG.md) +32 bit releases and previous releases can be found [here](https://github.com/IBM-Bluemix/bluemix-cli-release/releases) ## Extending with plugins -Check [plugin repository](http://plugins.ng.bluemix.net/ui/repository.html#bluemix-plugins) for any extension that enahnce the CLI capabilities. +Check [plugin repository](http://plugins.ng.bluemix.net/ui/repository.html#bluemix-plugins) for any extension that enhances the CLI capabilities. -To list the plugins in Bluemix CLI plugin repo: +To list the plugins in Bluemix plugin repository: ``` bluemix plugin repo-plugins @@ -59,7 +59,7 @@ bluemix plugin install PLUGIN_NAME -r Bluemix ## Release notes -Please refer to [here](./CHANGELOG.md) for details. +Please refer to [here](https://github.com/IBM-Bluemix/bluemix-cli-release/releases) for details. # Issues, defects and feature requests