Turn project into a proper upstream Perl project.

1 files changed, 60 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..7293098
--- /dev/null
+++ b/README
@@ -0,0 +1,60 @@
+NAME
+    Arctica::Services::Audio::Streamer::PulseAudio2GST - Core Perl modules for the Arctica Framework
+
+SYNOPSIS
+      use Arctica::Services::Audio::Streamer::PulseAudio2GST;
+
+      <usage-example-code>
+
+DESCRIPTION
+
+    <Introduction text>
+
+  Package Variables
+
+    <Some overall explanation>
+
+    $Arctica::Services::Audio::Streamer::PulseAudio2GST::<var1>
+        <Explanation on var1>.
+
+    $Arctica::Services::Audio::Streamer::PulseAudio2GST::<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::Server, Arctica::Telekinesis::Client,
+    perl-Arctica-Services-Audio-Streamer-PulseAudio,
+    perl::Arctica::Services::Audio::Streamer::ClientGST, perl.
+
+AUTHOR
+    AUTHOR_FULLNAME <AUTHOR_MAILADDRESS>
+
+COPYRIGHT
+      Copyright (c) 2015-2017 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.