Generate propper README.md

retupmoca · Jan 19, 2017 · f5838ac · f5838ac
1 parent e9e1729
commit f5838ac
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/META6.json b/META6.json
@@ -20,7 +20,7 @@
   "test-depends" : [
     "Test::META"
   ],
-  "description" : "XMPP Client",
+  "description" : "an XMPP client module",
   "production" : false,
   "version" : "0.0.1",
   "meta6" : "0",

diff --git a/README.md b/README.md
@@ -1,5 +1,16 @@
-P6-Net-XMPP
+[![Build Status](https://travis-ci.org/kalkin/Net-XMPP.svg?branch=master)](https://travis-ci.org/kalkin/Net-XMPP)
+
+NAME
+====
+
+Net::XMPP - an XMPP client module
+
+SYNOPSIS
+========
+
+    use Net::XMPP;
+
+DESCRIPTION
 ===========
 
-Net::XMPP is an XMPP client module. Currently does the initial connection for you,
-and then allows you to send and receive stanzas.
+Currently does the initial connection for you, and then allows you to send and receive stanzas.
diff --git a/lib/Net/XMPP.pm6 b/lib/Net/XMPP.pm6
@@ -172,3 +172,20 @@ method !get-raw-stanza {
         }
     }
 }
+
+=begin pod
+
+=head1 NAME
+
+Net::XMPP - an XMPP client module
+
+=head1 SYNOPSIS
+
+  use Net::XMPP;
+
+=head1 DESCRIPTION
+
+Currently does the initial connection for you, and then allows you to send and
+receive stanzas.
+
+=end pod