README.md in vandamme-0.0.1 vs README.md in vandamme-0.0.2
- old
+ new
@@ -1,8 +1,9 @@
# Vandamme
[](https://gemnasium.com/tech-angels/vandamme)
+[](https://travis-ci.org/tech-angels/vandamme)
Vandamme is a changelog parser gem, used in the [Gemnasium project](https://gemnasium.com)
## Installation
@@ -22,12 +23,49 @@
The Parser initializer will use 3 options:
* **:changelog**: full raw content of the changelog file
* **:version_header_exp**: regexp to match the versions lines in changelog
-* **:format** (*optional*): if you want to use the html converter, you must provide the original format of the changelog
+* **:format** (*optional*): if you want to use the html converter, you must provide the original format of the changelog. (default: 'raw')
+* **:group_match** (*optional*): Number of the match group is used for version matching. (default: 0)
+### Regex format
+
+**version_header_exp** will be converted to a new Regex object if it wasn't one.
+Therefore,
+
+ Vandamme::Parser.new(changelog: changelog, version_header_exp: '\d{4}-\d{2}-\d{2} \((\d\.\d+\.\d+)\)')
+
+is equivalent to:
+
+ Vandamme::Parser.new(changelog: changelog, version_header_exp: /\d{4}-\d{2}-\d{2} \((\d\.\d+\.\d+)\)/)
+
+Be careful with how ruby is handling escaped caracters in a string: ```"\d"``` if different from ```'\d'```!
+
+### Version Matching
+
+By default, the first match of the Regexp will be considered as the version number.
+ie:
+
+ 'Release (\d+\.\d+\.\d+)'
+
+will match lines like:
+
+ Release 1.3.5
+
+and '1.3.5' will be used as a key in the Hash returned by the ```parse``` method.
+Starting Vandamme 0.0.2, it's possible to specify which match group must be
+used for the version number, by passing the option **:match_group** to the
+initializer:
+
+ Vandamme::Parser.new([...], :matching_group => 1)
+
+The default match group is 0: this is the first group matched (0 being the
+original string), because we are using ```String#scan``` instead of
+```Regexp.match```.
+
+
## Examples
```ruby
require 'rubygems'
require 'vandamme'
@@ -50,5 +88,12 @@
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## Credits
+
+ Philippe Lafoucrière @ Tech-angels - http://www.tech-angels.com/
+
+ [](http://www.tech-angels.com)
+