README.md

@@ -1,24 +1,33 @@
 # Native Memory Agent
 
-Java agent to send native memory metrics to Stats
+Java agent to send native memory metrics to StatsD using UDP, every 5 seconds. 
 
 ## Build
 
 ```shell
 mvn clean package
 ```
 
+## Release
+
+```shell
+/opt/maven/apache-maven-3.9.2/bin/mvn release:prepare
+/opt/maven/apache-maven-3.9.2/bin/mvn release:perform -Darguments="-Dmaven.deploy.skip=true"
+```
 
 ## Usage
 
 ```shell
 wget https://docs.oracle.com/javase/tutorial/networking/sockets/examples/EchoServer.java
 nc -l -u -p 8125
-java -javaagent:target/native-memory-agent-1.0-SNAPSHOT.jar=localhost:8125,foo=bar \
+java -javaagent:target/native-memory-agent-1.0.jar=localhost:8125,foo=bar \
   -XX:NativeMemoryTracking=summary \
   EchoServer.java 8080
 ```
 
+ * `-XX:NativeMemoryTracking=summary` or `-XX:NativeMemoryTracking=detail` is required to active native memory tracking
+ * `localhost:8125` is the address for a UDP StatsD server
+ * `foo=bar` are tags to be sent along with metrics, delimted by a comma
 
 
 ## Acknowledgements

pom.xml

@@ -4,13 +4,13 @@
 
 	<groupId>org.example</groupId>
 	<artifactId>native-memory-agent</artifactId>
-	<version>1.0</version>
+	<version>1.1-SNAPSHOT</version>
 
 	<scm>
 		<connection>scm:git:git@github.com:premium-minds/native-memory-agent.git</connection>
 		<developerConnection>scm:git:git@github.com:premium-minds/native-memory-agent.git</developerConnection>
 		<url>https://github.com/premium-minds/native-memory-agent</url>
-		<tag>native-memory-agent-1.0</tag>
+		<tag>HEAD</tag>
 	</scm>
 
 	<properties>