README.md in fit4ruby-0.0.3 vs README.md in fit4ruby-0.0.4
- old
+ new
@@ -1,18 +1,30 @@
-Fit4Ruby
-========
+# Fit4Ruby
-Fit4Ruby is a Ruby libary to read and write FIT files. It is currently
-only tested with FIT files generated by the Garmin Forerunner 620.
+Fit4Ruby is a [http://www.ruby-lang.org](Ruby) libary to read and
+write FIT files.
This libary is still work in progress and probably not yet ready to be
used in your application. However, you are welcome to try it and send
-me comments and patches.
+me comments and patches. It was developed to form the back-end of
+[https://github.com/scrapper/postrunner](PostRunner).
-Usage
------
+## Supported Devices
+Tested devices: Garmin FR620
+
+Other Garmin devices that generate FIT files may work as well. Since I
+don't have any other devices, I can't add support for them.
+
+##Supported Operating Systems
+
+This library was developed and tested on Linux using Ruby 2.0 (MRI).
+Other operating systems that are Supported by Ruby 2.0 may probably
+work as well.
+
+##Usage
+
You can create an Activity.
```
require 'fit4ruby'
@@ -31,11 +43,11 @@
a.new_record({
:timestamp => ts,
:position_lat => 51.5512 - mins * 0.0008,
:position_long => 11.647 + mins * 0.002,
:distance => 200.0 * mins,
- :altitude => 100 + mins * 0.5,
+ :altitude => 100 + mins * 2,
:speed => 3.1,
:vertical_oscillation => 9 + mins * 0.02,
:stance_time => 235.0 * mins * 0.01,
:stance_time_percent => 32.0,
:heart_rate => 140 + mins,
@@ -93,11 +105,10 @@
```
Please see lib/fit4ruby/GlobalFitMessages.rb for the data fields that
are supported for the various FIT record types.
-License
--------
+## License
See [COPYING](COPYING) file.