summaryrefslogtreecommitdiff
path: root/README.rst
blob: 628601da8f0ffddad5fa28c7f44c69bce0979e2e (plain)
    1 README
    2 ======
    3 
    4 Versioner is a simple version string management application. It takes a version
    5 string, and performs the action (increment or decrement) on the specified
    6 digit.
    7 
    8 **NOTE**: This program assumes versions that are comprised of numbers only at
    9           this time.
   10 
   11 
   12 Usage
   13 -----
   14 
   15 **NOTE**: Arguments can be passed in any order.::
   16 
   17   versioner <version> <action> [<options>]
   18 
   19 Examples
   20 --------
   21 
   22 **Increment digit 2 of version 1.2.3.4**::
   23 
   24   versioner --increment 2 1.2.3.4
   25 
   26 This would output **1.3.0.0**.
   27 
   28 
   29 **Increment digit 3 of version 1.2.3.4**::
   30 
   31   versioner --increment 3 1.2.3.4
   32 
   33 This would output **1.2.4.0**.
   34 
   35 
   36 **Decrement digit 3 of version 1.2.3.4**::
   37 
   38   versioner --decrement 3 1.2.2.0
   39 
   40 This would output **1.2.2.0**.

Generated by cgit