From 0a875b45b13611a21b530df6ee34f746ddd38375 Mon Sep 17 00:00:00 2001
From: Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
Date: Thu, 20 Oct 2016 15:19:12 +0200
Subject: Add formal stuff for Perl packages.

---
 README | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README

(limited to 'README')

diff --git a/README b/README
new file mode 100644
index 0000000..c0a15cc
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+NAME
+    Arctica::Telekinesis::Client - Client implementation of Arctica Telekinesis
+
+SYNOPSIS
+      use Arctica::Telekinesis::Client;
+
+      <usage-example-code>
+
+DESCRIPTION
+
+    <Introduction text>
+
+  Package Variables
+
+    <Some overall explanation>
+
+    $Arctica::Telekinesis::Client::<var1>
+        <Explanation on var1>.
+
+    $Arctica::Telekinesis::Client::<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.
-- 
cgit v1.2.3