README.md in lightio-0.1.1 vs README.md in lightio-0.2.0

- old
+ new

@@ -1,10 +1,11 @@ # LightIO [![Gem Version](https://badge.fury.io/rb/lightio.svg)](http://rubygems.org/gems/lightio) -[![Build Status](https://travis-ci.org/jjyr/lightio.svg?branch=master)](https://travis-ci.org/jjyr/lightio) +[![Build Status](https://travis-ci.org/socketry/lightio.svg?branch=master)](https://travis-ci.org/socketry/lightio) +[![Coverage Status](https://coveralls.io/repos/github/socketry/lightio/badge.svg?branch=master)](https://coveralls.io/github/socketry/lightio?branch=master) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jjyr/lightio/blob/master/LICENSE.txt) LightIO is a ruby networking library, that combines ruby fiber and fast IO event loop. The intent of LightIO is to provide ruby stdlib compatible modules, that user can use these modules instead stdlib, to gain the benefits of IO event loop without care any details about react or async programming. @@ -28,38 +29,20 @@ Or install it yourself as: $ gem install lightio -## Usage - -``` ruby -require 'lightio' - -start = Time.now - -beams = 1000.times.map do - # LightIO::Beam is a thread-like executor, use it instead Thread - LightIO::Beam.new do - # do some io operations in beam - LightIO.sleep(1) - end -end - -beams.each(&:join) -seconds = Time.now - start -puts "1000 beams take #{seconds - 1} seconds to create" -``` - -View more [examples](/examples). - ## Documentation -See [wiki](https://github.com/jjyr/lightio/wiki) for more information +[Please see LightIO Wiki](https://github.com/jjyr/lightio/wiki) for more information. -[API Documentation](http://www.rubydoc.info/gems/lightio/frames) +The following documentations is also usable: +* [Basic usage](https://github.com/socketry/lightio/wiki/Basic-Usage) +* [YARD documentation](http://www.rubydoc.info/gems/lightio/frames) +* [Examples](/examples) + ## Discussion [Discussion on Gitter](https://gitter.im/lightio-dev/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link) ## Development @@ -73,9 +56,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jjyr/lightio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). + +Copyright, 2017, by [Jiang Jinyang](http://justjjy.com/) ## Code of Conduct Everyone interacting in the Lightio project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lightio/blob/master/CODE_OF_CONDUCT.md).