README.md in fonte-0.0.1 vs README.md in fonte-0.1.0
- old
+ new
@@ -5,11 +5,11 @@
[](http://travis-ci.org/reu/fonte)
## Examples
-Fonte comes with a bunch of parsers that can be used individually. Also, there is the `LogParser` which will then includes all the other `_*Parser_` to parse a full log file.
+Fonte comes with a bunch of parsers that can be used individually. Also, there is the `LogParser` which will then includes all the other `*Parser` to parse a full log file.
For example, if you wish to parse only a player informaton, you could use the PlayerParser:
```ruby
player = Fonte::Parsers::PlayerParser.new.parse("Reu<2><STEAM_1:1:24968171><Red>")
@@ -18,22 +18,23 @@
player.steam_id.value # => "STEAM_1:1:24968171"
player.steam_id.account_number.value # => 24968171
player.team.value # => "Red"
```
-Or you could parse a rcon authentication individually or within a log:
+Another case is parsing a rcon authentication individually and within a log:
```ruby
-rcon_authentication = Fonte::Parsers::PlayerParser.new.parse('Rcon: "rcon challenge "super secret" command" from "192.168.10.1:17015"')
+rcon_parser = Fonte::Parsers::RconParser.new
+rcon_authentication = rcon_parser.parse('Rcon: "rcon challenge "super secret" command" from "192.168.10.1:17015"')
rcon_authentication.password.value # => "super secret"
-```
-```ruby
-log = Fonte::Parsers::LogParser.new.parse('L 12/26/2011 - 02:14:33: Rcon: "rcon challenge "super secret" command" from "192.168.10.1:17015"')
-
+log_parser = Fonte::Parsers::LogParser.new
+log = log_parser.parse('L 12/26/2011 - 02:14:33: Rcon: "rcon challenge "super secret" command" from "192.168.10.1:17015"')
log.command.password.value # => "super secret"
log.date_time.day # => 26
```
-## Disclaimer
+## Games it supports
+In the current version it can parse all TF2, CSS and DOD files. Left4Dead is not supported yet due LOTS of "custom" events.
-This is a very early approach and can be a considered a proof of concept in the current version. Lots of things should (and will) be changed. For instance, I am not quite happy with the forced _".value"_ API, but for now, it was the easiest way to implement. Also, it doesn't support real games log yet, so, there should be a way to easily "plug" specific game "log commands".
+## Disclaimer
+This is a very early approach and can be a considered a proof of concept. Lots of things should (and will) be changed. For instance, I am not quite happy with the forced _".value"_ API, but for now, it was the easiest way to implement. Also, it doesn't support real games log yet, so, there should be a way to easily "plug" specific game "log commands".