#3 documentation

Author: Yegor Bugayenko

src/main/java/co/stateful/Atomic.java

@@ -64,6 +64,8 @@
  * @author Yegor Bugayenko (yegor@tpc2.com)
  * @version $Id$
  * @since 0.6
+ * @link <a href="http://www.yegor256.com/2014/05/18/cloud-autoincrement-counters.html">Atomic Counters at Stateful.co</a>
+ * @link <a href="http://www.yegor256.com/2014/12/04/synchronization-between-nodes.html">Synchronization Between Nodes</a>
  */
 @Loggable(Loggable.DEBUG)
 @ToString

src/main/java/co/stateful/RtSttc.java

@@ -50,6 +50,18 @@
 /**
  * Stateful Entry Point.
  *
+ * <p>Make an instance of this class and start from there, for example,
+ * if you want to use a cloud lock from
+ * <a href="http://www.stateful.co">stateful.co</a>:
+ *
+ * <pre> Lock lock = new RtSttc(
+ *   new URN("urn:github:12345"), "token"
+ * ).locks().lock("test");</pre>
+ *
+ * <p>You need two arguments to instantiate this class: URN of the user
+ * and your secret token. You can get them at the home page of
+ * <a href="http://www.stateful.co">stateful.co</a>, right on the top.
+ *
  * <p>It is highly recommended to use
  * {@link co.stateful.retry.ReSttc} decorator, in production
  * environment.</p>
@@ -61,6 +73,8 @@
  * @author Yegor Bugayenko (yegor@tpc2.com)
  * @version $Id$
  * @since 0.1
+ * @link <a href="http://www.yegor256.com/2014/05/18/cloud-autoincrement-counters.html">Atomic Counters at Stateful.co</a>
+ * @link <a href="http://www.yegor256.com/2014/12/04/synchronization-between-nodes.html">Synchronization Between Nodes</a>
  */
 @Immutable
 @Loggable(Loggable.DEBUG)

src/main/java/co/stateful/Sttc.java

@@ -35,9 +35,23 @@
 /**
  * Stateful Entry Point.
  *
+ * <p>Make an instance of this interface using {@link RtSttc}, for example,
+ * if you want to use a cloud lock from
+ * <a href="http://www.stateful.co">stateful.co</a>:
+ *
+ * <pre> Lock lock = new RtSttc(
+ *   new URN("urn:github:12345"), "token"
+ * ).locks().lock("test");</pre>
+ *
+ * <p>You need two arguments to instantiate {@link RtSttc}: URN of the user
+ * and your secret token. You can get them at the home page of
+ * <a href="http://www.stateful.co">stateful.co</a>, right on the top.
+ *
  * @author Yegor Bugayenko (yegor@tpc2.com)
  * @version $Id$
  * @since 0.1
+ * @link <a href="http://www.yegor256.com/2014/05/18/cloud-autoincrement-counters.html">Atomic Counters at Stateful.co</a>
+ * @link <a href="http://www.yegor256.com/2014/12/04/synchronization-between-nodes.html">Synchronization Between Nodes</a>
  */
 @Immutable
 public interface Sttc {

src/main/java/co/stateful/package-info.java

@@ -31,12 +31,12 @@
 /**
  * Stateful.co SDK.
  *
- * First, read the documentation at
+ * <p>First, read the documentation at
  * <a href="http://java-sdk.stateful.co">java-sdk.stateful.co</a>. Then,
  * register an account at <a href="http://www.stateful.co">stateful.co</a>.
  * Then, you can try to use, for example, counters:
  *
- * <pre>public class Main {
+ * <pre> public class Main {
  *   public static void main(String... args) {
  *     Sttc sttc = new RtSttc(
  *       new URN("urn:github:526301"),
@@ -51,8 +51,14 @@
  *   }
  * }</pre>
  *
+ * <p>You need two arguments to instantiate {@link RtSttc}: URN of the user
+ * and your secret token. You can get them at the home page of
+ * <a href="http://www.stateful.co">stateful.co</a>, right on the top.
+ *
  * @author Yegor Bugayenko (yegor@tpc2.com)
  * @version $Id$
  * @since 0.1
+ * @link <a href="http://www.yegor256.com/2014/05/18/cloud-autoincrement-counters.html">Atomic Counters at Stateful.co</a>
+ * @link <a href="http://www.yegor256.com/2014/12/04/synchronization-between-nodes.html">Synchronization Between Nodes</a>
  */
 package co.stateful;