README.md in rtanque-0.0.2 vs README.md in rtanque-0.1.0
- old
+ new
@@ -48,15 +48,24 @@
* [RTanque](http://rubydoc.info/github/awilliams/RTanque/master/frames/RTanque)
* [RTanque::Bot::Brain](http://rubydoc.info/github/awilliams/RTanque/master/frames/RTanque/Bot/Brain)
* [RTanque::Heading](http://rubydoc.info/github/awilliams/RTanque/master/frames/RTanque/Heading)
* [RTanque::Point](http://rubydoc.info/github/awilliams/RTanque/master/frames/RTanque/Point)
+## Sharing
+At some point you'll want to compete against other bots, or maybe you'll even organize a small tournament. Sharing bots is easy.
+
+Ask your friends to upload their bot(s) in a [gist](https://gist.github.com/), which you can then download with the following command:
+
+ bundle exec rtanque get_gist <gist_id> ...
+
+If you'd like to publicly share your bot, post its gist id on the wiki https://github.com/awilliams/RTanque/wiki/bot-gists
+
## Bot API
The tank api consists of reading input from Brain#sensors and giving output to Brain#command
-**Brain#sensors**
+**[Brain#sensors](http://rubydoc.info/github/awilliams/RTanque/master/frames/RTanque/Bot/Sensors)**
```ruby
class Bot < RTanque::Bot::Brain
# RTanque::Bot::Sensors =
# Struct.new(:ticks, :health, :speed, :position, :heading, :radar, :turret)
@@ -73,10 +82,10 @@
# Reflection(:heading, :distance, :name)
end
end
end
```
-**Brain#command**
+**[Brain#command](http://rubydoc.info/github/awilliams/RTanque/master/frames/RTanque/Bot/Command)**
```ruby
class Bot < RTanque::Bot::Brain
# RTanque::Bot::Command =
# Struct.new(:speed, :heading, :radar_heading, :turret_heading, :fire_power)