bash3boilerplate/README.md
Kevin van Zonneveld 71f487ae47 Update README.md
2013-03-20 15:35:46 +01:00

35 lines
1.1 KiB
Markdown

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/).
## Contributing
Feel free to fork this project. We will happily merge bug fixes or other
improvements.
## Versioning
BASH3 Boilerplate 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/.