Merge branch 'pretty-readme-md'

berekuk · Dec 10, 2011 · 14eaa01 · 14eaa01
2 parents d442bc0 + cd3205a
commit 14eaa01
Showing 1 changed file with 60 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,50 @@
-Ubic
-===========================
+# Ubic
 
 Ubic is a flexible perl-based service manager.
 
-INSTALLATION
+## 1 minute intro
+
+Put this code in file `/etc/ubic/service/example`:
+
+    use Ubic::Service::SimpleDaemon;
+    Ubic::Service::SimpleDaemon->new(
+      bin => 'sleep 1000',
+    );
+
+Start it:
+
+    $ ubic start example
+    Starting example... started (pid 41209)
+
+Check its status:
+
+    $ ubic status
+    example running (pid 41209)
+    ubic
+        ubic.ping   off
+        ubic.update off
+        ubic.watchdog   running (pid 93226)
+
+Or:
+
+    $ ubic status example
+    example running (pid 41209)
+
+Now let's see how watchdog works by killing the process (don't forget to change pid with the pid you got in status command above):
+
+    $ kill 41209
+
+    $ ubic status example
+    example not running
+
+    $ ubic-watchdog
+    [Thu May 26 20:20:54 2011]  example is broken, restarting
+
+You don't have to run ubic-watchdog manually; it will do its work in background in a minute.
+
+Read [Ubic::Manual::Intro](https://metacpan.org/module/Ubic::Manual::Intro) and [Ubic::Manual::Overview](https://metacpan.org/module/Ubic::Manual::Overview) for more.
+
+## Installation
 
 Run 'cpan -i Ubic && ubic-admin setup' to install Ubic.
 
@@ -14,7 +55,7 @@ Debian package build can be reproduced with this command:
 
 If you'll write ebuilds for Gentoo or specs for RPM-based systems, please contribute them back :)
 
-DOCUMENTATION
+## Documentation
 
 After installing, you can find documentation for this module using perldoc
 and man commands.
@@ -25,19 +66,29 @@ and man commands.
 You can also look for information at:
 
 * [Github Wiki](http://github.com/berekuk/Ubic/wiki)
-* [Search CPAN](http://search.cpan.org/dist/Ubic/)
+* [CPAN](https://metacpan.org/release/Ubic)
 
-SUPPORT
+## Support
 
-Our mailing list is <ubic-perl@googlegroups.com>. Send an empty message to <ubic-perl+subscribe@googlegroups.com> to subscribe.
+Our IRC channel: <irc://irc.perl.org#ubic>.
 
-These is also an IRC channel: <irc://irc.perl.org#ubic>.
+There is also a low-volume mailing list is <ubic-perl@googlegroups.com>. Send an empty message to <ubic-perl+subscribe@googlegroups.com> to subscribe.
 
-COPYRIGHT AND LICENCE
+
+## Copyright and licence
 
 Copyright (c) 2009-2011 Yandex LTD. All rights reserved.
 
 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 
 See <http://www.perl.com/perl/misc/Artistic.html>
 
+## Donate
+
+I don't actually need donations. I get paid at my $job for hacking on Ubic
+anyway.
+But I like Flattr's concept, so why not.
+
+[![Flattr this git repo](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=berekuk&url=http://github.com/berekuk/Ubic&title=Ubic&language=en_GB&tags=github&category=software)
+
+You can also +1 Ubic on [MetaCPAN](https://metacpan.org/release/Ubic) if you like it.