Permalink
Browse files

added info to readme

  • Loading branch information...
1 parent e992aed commit b68bdcdb84d553c9cb505d0d9e0dad3bcfdd67f8 @brendannee committed Feb 28, 2011
Showing with 46 additions and 11 deletions.
  1. +0 −11 README
  2. +46 −0 README.md
View
11 README
@@ -1,11 +0,0 @@
-hi all
---== OVERVIEW ==--
-
-Bikesy frontend is HTML, CSS and Javascript used to display bike routes provided by the Bikesy Backend: http://github.com/brendannee/Bikesy-Backend
-
-Bikesy frontend supplies a user interface for users to specify a start and end point to a route along with a hill tolerance. It uses Google Maps API to display the routes provided by the Bikesy Backend and allows drag and drop start/end points.
-
-
---== EXAMPLE ==--
-
-You can see the Bikesy frontend in use at http://bikesy.com
View
@@ -0,0 +1,46 @@
+Bikesy Frontend
+=========
+
+Bikesy Frontend is HTML, CSS and Javascript used to display bike routes provided by the [Bikesy Backend] http://github.com/brendannee/Bikesy-Backend
+
+The Bikesy frontend allows users to specify a start and end point to a route along with a hill tolerance (from avoiding hills to not weighting them much at all). It uses Google Maps API to display the routes provided by the Bikesy Backend and allows drag and drop start/end points.
+
+### Bikesy API
+
+You can pull info directly from the bikesy backend using the [Bikesy API]http://blog.bikesy.com/api/: http://blog.bikesy.com/api/
+
+
+The assumptions that go into the routes provided by the Bikesy API are documented on the [Bikesy API page]http://blog.bikesy.com/api/ .
+
+### Example
+
+You can see the Bikesy frontend in use at http://bikesy.com
+
+### Credits
+
+Brendan Nee brendan@blinktag.com
+
+### License
+
+(The MIT License)
+
+Copyright (c) 2010 BlinkTag Inc <info@blinktag.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit b68bdcd

Please sign in to comment.