Add formal stuff for Perl packages.

1 files changed, 58 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..1eb3755
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+NAME
+    Arctica::Telekinesis::Server - Core Perl modules for the Arctica Framework
+
+SYNOPSIS
+      use Arctica::Telekinesis::Server;
+
+      <usage-example-code>
+
+DESCRIPTION
+
+    <Introduction text>
+
+  Package Variables
+
+    <Some overall explanation>
+
+    $Arctica::Telekinesis::Server::<var1>
+        <Explanation on var1>.
+
+    $Arctica::Telekinesis::Server::<var2>
+        <Explanation on var2>.
+
+  Class Methods
+
+    <method-name-1>
+
+        This method does ....
+
+    <method-name-1>
+
+        This method does ....
+
+  Instance Methods
+
+    <method-name-1>
+
+        This method does ....
+
+    <method-name-1>
+
+        This method does ....
+
+  Overloaded Operators
+
+    <overloaded-operator-1>
+
+        Explanation on this...
+
+SEE ALSO
+    Arctica::Telekinesis::Client, perl.
+
+AUTHOR
+    AUTHOR_FULLNAME <AUTHOR_MAILADDRESS>
+
+COPYRIGHT
+      Copyright (c) 2015-2016 Arctica Project.  All rights reserved.
+      This module is free software; you can redistribute it and/or modify it
+      under the same terms of the <LICENSE> license.