README.md in buschtelefon-0.1.0 vs README.md in buschtelefon-0.2.0

- old
+ new

@@ -1,7 +1,9 @@ # Buschtelefon +[![Travis Build Status](https://travis-ci.org/renuo/buschtelefon.svg?branch=master)](https://travis-ci.org/renuo/buschtelefon) + With *buschtelefon* you can setup a gossiping meshnet. All of it should behave just like human beings tattling at a coffee party. There basically are two features: @@ -11,11 +13,12 @@ Communication happens via UDP. Autodiscovery of nodes is not implemented (yet). ## Installation -Add this line to your application's Gemfile: +You can use this gem with Ruby versions starting from 2.1. +Add the following line to your application's Gemfile: ```ruby gem 'buschtelefon' ``` @@ -27,19 +30,24 @@ $ gem install buschtelefon ## Usage -You can setup your tattling meshnet the following way: +You can setup your local tattling meshnet the following way: ```ruby include Buschtelefon -aunt_may = NetTattler.new(port: 1337) -aunt_ruth = RemoteTattler.new(host: 'example.com', port: 1337) -aunt_may.connect(aunt_ruth) +aunt_may = NetTattler.new +aunt_ruth = NetTattler.new +remote_aunt_ruth = RemoteTattler.new(host: 'localhost', port: aunt_ruth.port) -aunt_may.feed(Gossip.new('Renuo can do blockchain consulting!')) +aunt_may.connect(remote_aunt_ruth) + +Thread.new { aunt_may.listen } +Thread.new { aunt_ruth.listen } + +aunt_may.feed(Gossip.new('Did you hear about the cool company "Renuo"?')) ``` ## Development After checking out the repo, run `bin/setup` to install dependencies.