Merge 8fe90a4 into c3b70d7

CHANGELOG.md

@@ -5,13 +5,11 @@ on [Keep a CHANGELOG](http://keepachangelog.com/). This project adheres to
 
 ## [Unreleased]
 ### Added
+- Initial release of the catchup-shuttering-manager CLI tool, supporting invocation of the event sourcing frameworks SHUTTER, UNSHUTTER, CATCHUP, REBUILD operations.
 - New command '--list' which lists the commands available on your Wildfly instance.
 - Authentication to a remote Wildfly instance with commands '--username' and '--password'
 ### Changed
 - Application now run in a Weld container to allow for dependency injection
 
-## [1.0.0] - 2019-06-19
 
-### Added
-- Initial release of the catchup-shuttering-manager CLI tool, supporting invocation of the event sourcing frameworks SHUTTER, UNSHUTTER, CATCHUP, REBUILD operations.
 

README.md

@@ -1,22 +1,30 @@
 # Framework Jmx Command Client
 
-[![Build Status](https://travis-ci.org/CJSCommonPlatform/catchup-and-shuttering-manager.svg?branch=master)](https://travis-ci.org/CJSCommonPlatform/catchup-and-shuttering-manager) [![Coverage Status](https://coveralls.io/repos/github/CJSCommonPlatform/catchup-and-shuttering-manager/badge.svg?branch=master)](https://coveralls.io/github/CJSCommonPlatform/catchup-and-shuttering-manager?branch=master)
+[![Build Status](https://travis-ci.org/CJSCommonPlatform/framework-jmx-command-client.svg?branch=master)](https://travis-ci.org/CJSCommonPlatform/framework-jmx-command-client) [![Coverage Status](https://coveralls.io/repos/github/CJSCommonPlatform/framework-jmx-command-client/badge.svg?branch=master)](https://coveralls.io/github/CJSCommonPlatform/framework-jmx-command-client?branch=master)
+
+Command line client tool for running Framework System Commands against any framework based context.
+
+From Framework 6.0.0 and above
 
 ## Usage
 
-catchup-shuttering-manager
- -c,--command <arg>     Framework command to execute.
- -h,--help              Show help.
- -ho,--host <arg>       Hostname or IP address of the Wildfly server. Defaults to localhost
- -p,--port <arg>        Wildfly management port. Defaults to 9990 (the default for Wildfly)
- -u, --username         Optional username for Wildfly management security
- -pw, --password        Optional password for Wildfly management security
- -l, --list             List of all framework commands
- 
+**java -jar framework-jmx-command-client.jar _\<options\>_**
+
+- **-c,--command** <arg>     _The name of the System Command to run_
+- **-h,--host** <arg>        _Hostname or IP address of the Wildfly server. Defaults to localhost_
+- **-p,--port** <arg>        _Wildfly management port. Defaults to 9990 (the default for Wildfly)_
+- **-u, --username**         _Optional username for Wildfly management security_
+- **-pw, --password**        _Optional password for Wildfly management security_
+- **-l, --list**             _Shows a list of all framework System Commands and exits_
+- **--help**                 _Show help message and exits._
 
- java -jar catchup-shuttering-manager.jar -c "PING"
+### For example 
+_java -jar framework-jmx-command-client.jar --command PING_
+
+Would run the command 'PING' against a local wildfly instance with no authentication
 
- Note: If you are running wildfly on your local machine and running as the same user as the one you are
+###### Note: 
+ If you are running wildfly on your local machine and running as the same user as the one you are
  logged in as, then username/password are not required. (However, if running wildfly in a virtual machine
  like vagrant, username and password will be required)
 

pom.xml

@@ -11,11 +11,11 @@
         <version>1.7.1</version>
     </parent>
 
-    <artifactId>catchup-shuttering-manager</artifactId>
+    <artifactId>framework-jmx-command-client</artifactId>
     <version>1.0.0-SNAPSHOT</version>
 
     <properties>
-        <cpp.repo.name>catchup-shuttering-manager</cpp.repo.name>
+        <cpp.repo.name>framework-jmx-command-client</cpp.repo.name>
 
         <framework-api.version>4.0.1</framework-api.version>
         <framework.version>6.0.0-RC4</framework.version>