diff --git a/README b/README
index 7ed91c2..5a7bcb2 100644
--- a/README
+++ b/README
@@ -1,8 +1,10 @@
= GPX Gem
+
Copyright (C) 2006 Doug Fales
Doug Fales mailto:doug@falesafeconsulting.com
== What It Does
+
This library reads GPX files and provides an API for reading and manipulating
the data as objects. For more info on the GPX format, see
http://www.topografix.com/gpx.asp.
@@ -14,19 +16,21 @@ the tracks and points in a file (such as distance, duration, average speed,
etc).
== Examples
+
Reading a GPX file, and cropping its contents to a given area:
- gpx = GPX::GPXFile.new(:gpx_file => filename) # Read GPX file
- bounds = GPX::Bounds.new(params) # Create a rectangular area to crop
- gpx.crop(bounds) # Crop it
- gpx.write(filename) # Save it
+ gpx = GPX::GPXFile.new(:gpx_file => filename) # Read GPX file
+ bounds = GPX::Bounds.new(params) # Create a rectangular area to crop
+ gpx.crop(bounds) # Crop it
+ gpx.write(filename) # Save it
Converting a Magellan track log to GPX:
- if GPX::MagellanTrackLog::is_magellan_file?(filename)
- GPX::MagellanTrackLog::convert_to_gpx(filename, "#{filename}.gpx")
- end
+ if GPX::MagellanTrackLog::is_magellan_file?(filename)
+ GPX::MagellanTrackLog::convert_to_gpx(filename, "#{filename}.gpx")
+ end
== Notes
+
This library was written to bridge the gap between my Garmin Geko
and my website, WalkingBoss.org (RIP). For that reason, it has always been more of a
work-in-progress than an attempt at full GPX compliance. The track side of the