bash3boilerplate/README.md

# bash3boilerplate

<!-- badges/ -->
[![Build Status](https://secure.travis-ci.org/kvz/bash3boilerplate.png?branch=master)](http://travis-ci.org/kvz/bash3boilerplate "Check this project's build status on TravisCI")
[![Gittip donate button](http://img.shields.io/gittip/kvz.png)](https://www.gittip.com/kvz/ "Sponsor the development of bash3boilerplate via Gittip")
[![Flattr donate button](http://img.shields.io/flattr/donate.png?color=yellow)](https://flattr.com/submit/auto?user_id=kvz&url=https://github.com/kvz/bash3boilerplate&title=bash3boilerplate&language=&tags=github&category=software "Sponsor the development of bash3boilerplate via Flattr")
[![PayPayl donate button](http://img.shields.io/paypal/donate.png?color=yellow)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=kevin%40vanzonneveld%2enet&lc=NL&item_name=Open%20source%20donation%20to%20Kevin%20van%20Zonneveld&currency_code=USD&bn=PP-DonationsBF%3abtn_donate_SM%2egif%3aNonHosted "Sponsor the development of bash3boilerplate via Paypal")
[![BitCoin donate button](http://img.shields.io/bitcoin/donate.png?color=yellow)](https://coinbase.com/checkouts/19BtCjLCboRgTAXiaEvnvkdoRyjd843Dg2 "Sponsor the development of bash3boilerplate via BitCoin")
<!-- /badges -->

When hacking up BASH scripts, I often find there are some
higherlevel things like logging, configuration, commandline argument
parsing that:

 - I need everytime
 - Take quite some effort to get right
 - Keep you from your actual work

Here's an attempt to bundle those things in a generalized way so that
they are reusable as-is in most of my (and hopefully your, if not ping
me) programs.

An up to date [intro is found on my blog](http://kvz.io/blog/2013/02/26/introducing-bash3boilerplate/).

## Versioning

This project implements the Semantic Versioning guidelines.

Releases will be numbered with the following format:

`<major>.<minor>.<patch>`

And constructed with the following guidelines:

* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch


For more information on SemVer, please visit [http://semver.org](http://semver.org).

## License

Copyright (c) 2013 Kevin van Zonneveld, [http://kvz.io](http://kvz.io)  
Licensed under MIT: [http://kvz.io/licenses/LICENSE-MIT](http://kvz.io/licenses/LICENSE-MIT)
Update README.md 2014-01-12 11:03:32 +00:00			`# bash3boilerplate`

			`<!-- badges/ -->`
			`[![Build Status](https://secure.travis-ci.org/kvz/bash3boilerplate.png?branch=master)](http://travis-ci.org/kvz/bash3boilerplate "Check this project's build status on TravisCI")`
			`[![Gittip donate button](http://img.shields.io/gittip/kvz.png)](https://www.gittip.com/kvz/ "Sponsor the development of bash3boilerplate via Gittip")`
			`[![Flattr donate button](http://img.shields.io/flattr/donate.png?color=yellow)](https://flattr.com/submit/auto?user_id=kvz&url=https://github.com/kvz/bash3boilerplate&title=bash3boilerplate&language=&tags=github&category=software "Sponsor the development of bash3boilerplate via Flattr")`
			`[![PayPayl donate button](http://img.shields.io/paypal/donate.png?color=yellow)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=kevin%40vanzonneveld%2enet&lc=NL&item_name=Open%20source%20donation%20to%20Kevin%20van%20Zonneveld&currency_code=USD&bn=PP-DonationsBF%3abtn_donate_SM%2egif%3aNonHosted "Sponsor the development of bash3boilerplate via Paypal")`
			`[![BitCoin donate button](http://img.shields.io/bitcoin/donate.png?color=yellow)](https://coinbase.com/checkouts/19BtCjLCboRgTAXiaEvnvkdoRyjd843Dg2 "Sponsor the development of bash3boilerplate via BitCoin")`
			`<!-- /badges -->`

SemVer. More consistent docs 2013-02-25 22:54:34 +00:00			`When hacking up BASH scripts, I often find there are some`
First swing at readme 2013-02-25 22:39:31 +00:00			`higherlevel things like logging, configuration, commandline argument`
SemVer. More consistent docs 2013-02-25 22:54:34 +00:00			`parsing that:`
First swing at readme 2013-02-25 22:39:31 +00:00
			`- I need everytime`
SemVer. More consistent docs 2013-02-25 22:54:34 +00:00			`- Take quite some effort to get right`
			`- Keep you from your actual work`
First swing at readme 2013-02-25 22:39:31 +00:00
			`Here's an attempt to bundle those things in a generalized way so that`
			`they are reusable as-is in most of my (and hopefully your, if not ping`
			`me) programs.`

Move intro to blog 2013-02-25 23:30:30 +00:00			`An up to date [intro is found on my blog](http://kvz.io/blog/2013/02/26/introducing-bash3boilerplate/).`
First swing at readme 2013-02-25 22:39:31 +00:00
Move intro to blog 2013-02-25 23:30:30 +00:00			`## Versioning`
First swing at readme 2013-02-25 22:39:31 +00:00
Update README.md 2013-03-27 15:05:58 +00:00			`This project implements the Semantic Versioning guidelines.`
First swing at readme 2013-02-25 22:39:31 +00:00
Move intro to blog 2013-02-25 23:30:30 +00:00			`Releases will be numbered with the following format:`
First swing at readme 2013-02-25 22:39:31 +00:00
Move intro to blog 2013-02-25 23:30:30 +00:00			`<major>.<minor>.<patch>`
First swing at readme 2013-02-25 22:39:31 +00:00
Move intro to blog 2013-02-25 23:30:30 +00:00			`And constructed with the following guidelines:`
First swing at readme 2013-02-25 22:39:31 +00:00
Move intro to blog 2013-02-25 23:30:30 +00:00			`* Breaking backward compatibility bumps the major (and resets the minor and patch)`
			`* New additions without breaking backward compatibility bumps the minor (and resets the patch)`
			`* Bug fixes and misc changes bumps the patch`
First swing at readme 2013-02-25 22:39:31 +00:00
Update README.md 2013-03-27 16:54:31 +00:00
			`For more information on SemVer, please visit [http://semver.org](http://semver.org).`
Update README.md 2013-03-27 15:08:31 +00:00
			`## License`

Update README.md 2013-03-27 16:56:19 +00:00			`Copyright (c) 2013 Kevin van Zonneveld, [http://kvz.io](http://kvz.io)`
Update README.md 2013-03-28 13:23:24 +00:00			`Licensed under MIT: [http://kvz.io/licenses/LICENSE-MIT](http://kvz.io/licenses/LICENSE-MIT)`