From 34c10fc91c6dd50c8583e816725aa1ebabb88aac Mon Sep 17 00:00:00 2001
From: Pekka Enberg <penberg@scylladb.com>
Date: Fri, 3 Mar 2017 12:35:00 +0200
Subject: [PATCH] README update

Fix the last remaining mention of "Urchin" and clean up the instructions on how to run it.
---
 README.md | 35 +++++++++++++++++++----------------
 1 file changed, 19 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index c1e47f1..e2c45f3 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,25 @@
-# Urchin JMX Interface
-This is the JMX interface for Scylla
-## Compile
-To compile do:
-```
-mvn install
+# Scylla JMX Server
+
+Scylla JMX server implements the Apache Cassandra JMX interface for compatibility with tooling such as `nodetool`. The JMX server uses Scylla's REST API to communicate with a Scylla server.
+
+## Compiling
+
+To compile JMX server, run:
+
+```console
+$ mvn package
 ```
 
-## Run
-The maven will create an uber-jar with all dependency under the target directory. You should run it with the remote jmx enable so the nodetool will be able to connect to it.
+## Running
 
-```
-java -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=7199 -Dcom.sun.management.jmxremote.local.only=false -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false -jar target/scylla-jmx-1.0.jar
+To start the JMX server, run:
+
+```console
+$ ./scripts/scylla-jmx
 ```
 
-## Setting IP and Port
-By default the the JMX would connect to a node on the localhost
-on port 10000.
+To get help on supported options:
 
-The jmx API uses the system properties to set the IP address and Port.
-To change the ip address use the apiaddress property (e.g. -Dapiaddress=1.1.1.1)
-To change the port use the apiport (e.g. -Dapiport=10001)
+```console
+$ ./scripts/scylla-jmx --help
+```