Browse Source

Doc update.

Jakob Borg 13 years ago
parent
commit
4fc4a81431
1 changed files with 14 additions and 9 deletions
  1. 14 9
      README.md

+ 14 - 9
README.md

@@ -1,12 +1,15 @@
-      ____     ____    ___      __     _____   _____      __   _ __ 
-     /\_ ,`\  /',__\ /' _ `\  /'__`\  /\ '__`\/\ '__`\  /'__`\/\`'__\
-     \/_/  /_/\__, `\/\ \/\ \/\ \L\.\_\ \ \L\ \ \ \L\ \/\  __/\ \ \/
-       /\____\/\____/\ \_\ \_\ \__/.\_\\ \ ,__/\ \ ,__/\ \____\\ \_\
-       \/____/\/___/  \/_/\/_/\/__/\/_/ \ \ \/  \ \ \/  \/____/ \/_/
-                                         \ \_\   \ \_\
-                                          \/_/    \/_/
-
-This is a ZFS snapshotting service for Solaris, OpenIndiana, SmartOS and friends.
+```
+ _______ _ __   __ _ _ __  _ __   ___ _ __
+|_  / __| '_ \ / _` | '_ \| '_ \ / _ \ '__|
+ / /\__ \ | | | (_| | |_) | |_) |  __/ |
+/___|___/_| |_|\__,_| .__/| .__/ \___|_|
+                    |_|   |_|
+```
+
+This is a ZFS snapshotting service for Solaris, OpenIndiana, SmartOS and
+friends. It takes periodic snapshots of the datasets you specify, at whatever
+intervals you like. You tell it how many of each kind to keep around and the
+rest gets cleaned out.
 
 
 Installation
 Installation
 ============
 ============
@@ -23,9 +26,11 @@ Two alternatives:
  2.  In a zone that has npm and build tools available, or on a machine running
  2.  In a zone that has npm and build tools available, or on a machine running
      Mac OS X or whatever with Node.js installed:
      Mac OS X or whatever with Node.js installed:
 
 
+     ```
      # git clone https://github.com/calmh/zsnapper.git
      # git clone https://github.com/calmh/zsnapper.git
      # cd zsnapper
      # cd zsnapper
      # fakeroot make smartos
      # fakeroot make smartos
+     ```
 
 
 Transfer the tarball to your GZ and unpack it from the root. Read below about
 Transfer the tarball to your GZ and unpack it from the root. Read below about
 configuring (the config file is in `/opt/local/etc`), then enable the service
 configuring (the config file is in `/opt/local/etc`), then enable the service