X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fnet%2Fpterodactylus%2Futil%2Ffcp%2Fpackage-info.java;h=b39b8e5c7f4e0e9973ddf4581124bb3144602b9e;hb=9d55936cc51f39b1f45d28b7872ddc712f7c9b2f;hp=0567b506de6f357abd8d501d873f849cdb2ba5b3;hpb=474a0f39c87d520b0ce8c23ea8e8046441e13ea7;p=jSite2.git

diff --git a/src/net/pterodactylus/util/fcp/package-info.java b/src/net/pterodactylus/util/fcp/package-info.java
index 0567b50..b39b8e5 100644
--- a/src/net/pterodactylus/util/fcp/package-info.java
+++ b/src/net/pterodactylus/util/fcp/package-info.java
@@ -1,4 +1,35 @@
 /**
- * Package that holds all the message types that are used in the communication with a Freenet Node.
+ * Package that holds all the message types that are used in the communication
+ * with a Freenet Node.
+ * 
+ * <h2>Usage</h2>
+ * 
+ * This library was designed to implement the full range of the Freenet Client
+ * Protocol, Version 2.0. At the moment the library provides a rather low-level
+ * approach, wrapping each FCP message into its own object but some kind of
+ * high-level client that does not require any interfaces to be implemented
+ * will probably provided as well.
+ * 
+ * First, create a connection to the node:
+ * 
+ * <pre>
+ * FcpConnection fcpConnection = new FcpConnection();
+ * </pre>
+ * 
+ * Now implement the {@link net.pterodactylus.util.fcp.FcpListener} interface
+ * and handle all incoming events.
+ * 
+ * <pre>
+ * public class MyClass implements FcpListener {
+ * 
+ * 	public void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
+ * 		…
+ * 	}
+ * 
+ * 	// implement all further methods here
+ * 
+ * }
+ * </pre>
  */
-package net.pterodactylus.util.fcp;
\ No newline at end of file
+package net.pterodactylus.util.fcp;
+