README.md in vdf-0.1.0 vs README.md in vdf-1.0.0
- old
+ new
@@ -1,8 +1,8 @@
-# Vdf
+# VDF
-VDF is a gem to convert Valve's KeyValue format to ruby hashes and back, based on the excellent https://github.com/node-steam/vdf
+VDF is a gem to convert Valve's KeyValue format to ruby hashes and back, based on the excellent [node-steam/vdf](https://github.com/node-steam/vdf)
## Installation
Add this line to your application's Gemfile:
@@ -18,11 +18,11 @@
$ gem install vdf
## Usage
-Parsing a VDF is simple:
+Parsing a VDF file is simple:
```ruby
require "vdf"
# Load VDF file into a string
@@ -34,23 +34,56 @@
# Pretty-print the result
p parsed
```
+Creating one is too:
+
+```ruby
+require "vdf"
+
+# Set up hash to generate a VDF from
+object = {
+ "string" => "string",
+ "false" => false,
+ "true" => true,
+ "number" => 1234,
+ "float" => 12.34,
+ "null" => nil,
+ "nested" => {
+ "string" => "string",
+ "deep" => {
+ "string" => "string"
+ }
+ }
+}
+
+# Generate a VDF string and output it
+puts VDF.generate(object)
+
+```
+
## Performance comparison
Small VDF File
```
- user system total real
-vdf4r 0.391000 0.000000 0.391000 ( 0.383975)
-vdf 0.016000 0.000000 0.016000 ( 0.012664)
+ user system total real
+vdf 0.015000 0.000000 0.015000 ( 0.013349)
+vdf4r 0.391000 0.000000 0.391000 ( 0.389993)
```
-Large VDF File (CS:GO's items_game.txt)
+Large VDF File (4MB - CS:GO's items_game.txt)
+```
+ user system total real
+vdf 1.312000 0.031000 1.343000 ( 1.348015)
+vdf4r 53.422000 0.016000 53.438000 ( 54.020029)
+```
+Compared to the [vdf4r gem](https://github.com/skadistats/vdf4r) using [this script](https://gist.github.com/sapphyrus/3aab81ad06949c3743ad91e20ccf7c65).
+
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/vdf.
+Bug reports and pull requests are welcome on GitHub at https://github.com/sapphyrus/vdf.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).