[wiki.stajistics] push by - Created wiki page through web user interface. on 2011-06-21 02:55 GMT

[staji...@googlecode.com]

Revision: 3846bae754df
Author: troy.k...@gmail.com
Date: Mon Jun 20 19:55:34 2011
Log: Created wiki page through web user interface.
http://code.google.com/p/stajistics/source/detail?repo=wiki&r=3846bae754df

Added:
/GettingStajistics.wiki

=======================================
--- /dev/null
+++ /GettingStajistics.wiki Mon Jun 20 19:55:34 2011
@@ -0,0 +1,66 @@
+#summary How to get and install Stajistics
+
+== Prerequisites ==
+
+The most basic use of Stajistics requires Java 1.6. It is recommended that
Stajistics be used in application configurations that expose management via
JMX. While Stajistics can happily collect statistics without it, being able
to monitor statistics in real time using JMX is really where Stajistics
shines.
+
+== Getting Stajistics ==
+
+Release binaries and source packages are available in the downloads
section (look up).
+
+Release builds and snapshot builds are also available through the Maven
repository (see below).
+
+== Installing Stajistics ==
+
+Installation only requires that you add `stajistics-core-<version>.jar`
and its dependent jars to your project classpath. The only dependency of
the stajistics-core module is `slf4j-api-<version>.jar` for logging. Refer
to [http://www.slf4j.org the SLF4J website] for information on how to
configure logging.
+
+Stajistics provides feature extensions in the form of separate module
jars. One of the reasons for this is that a given feature may require
additional dependency jars. This project model allows the user to select
the desired features while not forcing the need for dependency jars of
undesired features.
+
+=== Using Maven ===
+
+==== Releases ====
+
+NOTE: THE MAVEN REPOSITORY IS CURRENTLY DOWN. PLEASE DOWNLOAD ARTEFACTS
FROM THE DOWNLOADS SECTION FOR THE TIME BEING. Sorry :(
+
+Add the following to your repositories:
+
+{{{
+ <repositories>
+ <repository>
+ <id>stajistics</id>
+ <url>http://repository.stajistics.org/releases</url>
+ </repository>
+ </repositories>
+}}}
+
+Add the following to your dependencies:
+
+{{{
+ <dependency>
+ <groupId>org.stajistics</groupId>
+ <artifactId>stajistics-core</artifactId>
+ <version>[version]</version>
+ </dependency>
+}}}
+
+==== Snapshots ====
+
+Add the following to your repositories:
+{{{
+ <repository>
+ <id>stajistics</id>
+ <url>http://repository.stajistics.org/snapshots</url>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+}}}
+
+Add the following to your dependencies:
+{{{
+ <dependency>
+ <groupId>org.stajistics</groupId>
+ <artifactId>stajistics-core</artifactId>
+ <version>[version]-SNAPSHOT</version>
+ </dependency>
+}}}