SEBA-687 Add release information.
Change-Id: I4cdfe99de9d9c8543830121c3c67452280947985
diff --git a/README.md b/README.md
index 4e2f8da..7122cc6 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,17 @@
# cordctl
+
---
`cordctl` is a command-line tool for interacting with XOS. XOS is part of the SEBA NEM and part of CORD, so by extension this tool is useful for interacting with SEBA and CORD deployments. `cordctl` makes use of gRPC to connect to XOS and may by used for administration of a remote pod, assuming the appropriate firewall rules are configured. Typically XOS exposes its gRPC API on port `30011`.
+## Obtaining cordctl
+
+Binaries for `cordctl` are published at https://github.com/opencord/cordctl/releases and may be directly downloaded and used on Linux, MAC, or Windows platforms.
+
+Additionally, the source for `cordctl` is available at https://github.com/opencord/cordctl and may be downloaded and built. `cordctl` is written in golang, and go version 1.12 or above must be installed in order to build from source.
+
+If you would like to contribute to `cordctl`, the preferred process is to submit patches for code review through gerrit at https://gerrit.opencord.org.
+
## Configuration
Typically a configuration file should be placed at `~/.cord/config` as `cordctl` will automatically look in that location. Alternatively, the `-c` command-line option may be used to specify a different config file location. Below is a sample config file:
@@ -15,7 +24,9 @@
timeout: 10s
```
-The `server`, `username`, and `password` parameters are essential to configure access to the XOS container running on your pod.
+The `server`, `username`, and `password` parameters are essential to configure access to the XOS container running on your pod.
+
+To generate a config file on stdout from the currently configured settings, the command `cordctl config` may be used.
## Getting Help
@@ -33,6 +44,7 @@
```
## Shell Completion
+
`cordctl` supports shell completion for the `bash` shell. To enable
shell Completion you can use the following command on *most* \*nix based system.
```bash
diff --git a/VERSION b/VERSION
index 3eefcb9..3f60217 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.0.0
+1.0.1-dev