flammarion 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d906902eec515151cf5ffa60a925b8848dd6360b15a46424cf5844e60e84e7f
+  data.tar.gz: 2eae984109a6b8b6a3bd44696d0a61a39387e4fc3169bc9fd6fb74c380b1a877
+SHA512:
+  metadata.gz: 6623eec5b91e815dbb040911d601d262cb1a846e669aa7eae1919b3bfc40d731c073a83337f921db311a2dc96c4453855102b961f4b7175394c5504b7ca5afb2
+  data.tar.gz: c7158ed9aa81e1a4d366a76176b2aa9345aa55db01d9bec76d45acc3945d15d0f863fafb010eff5afadaa9928ef9520d1ea99a3a250cc08e81e5ad8e079184de

data/LICENSE

@@ -1,147 +1,165 @@
-# Flammarion
-
-Copyright (c) 2015 Zachary Capalbo
-
-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.
-
-
-# External Packages
-
-Flammarion is bundled with a number of 3rd party packages:
-
-## Font Awesome
-
-This software incorporates
-[Font Awesome by Dave Gandy - http://fontawesome.io](http://fontawesome.io). The
-fonts in Font Awesome are licensed under the
-[SIL OFL 1.1](http://scripts.sil.org/OFL). The css files in Font Awesome are
-licensed under the [MIT License](http://opensource.org/licenses/mit-license.html)
-
-C.f. https://fortawesome.github.io/Font-Awesome/license/
-
-## JQuery
-
-jQuery Foundation projects are released under the terms of the license specified in the project's repository or if not specified, under the [MIT license](https://tldrlegal.com/license/mit-license)
-
-## Highlight JS
-
-Copyright (c) 2006, Ivan Sagalaev
-All rights reserved.
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-    * Neither the name of highlight.js nor the names of its contributors
-      may be used to endorse or promote products derived from this software
-      without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
-EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-## Leaflet
-
-Copyright (c) 2010-2015, Vladimir Agafonkin
-Copyright (c) 2010-2011, CloudMade
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are
-permitted provided that the following conditions are met:
-
-   1. Redistributions of source code must retain the above copyright notice, this list of
-      conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright notice, this list
-      of conditions and the following disclaimer in the documentation and/or other materials
-      provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
-EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
-TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-## Rubame
-
-(The MIT License)
-
-Copyright © 2013 Mark Saward
-
-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.
-
-## Emojione
-
-Emoji provided free by [Emoji One](http://emojione.com)
-
-#### Emoji One Artwork
-
-*  Applies to all PNG and SVG files as well as any adaptations made.
-*  License: Creative Commons Attribution 4.0 International
-*  Human Readable License: http://creativecommons.org/licenses/by/4.0/
-*  Complete Legal Terms: http://creativecommons.org/licenses/by/4.0/legalcode
-
-
-#### Emoji One Non-Artwork
-
-*  Applies to the Javascript, JSON, PHP, CSS, HTML files, and everything else not covered under the artwork license above.
-*  License: MIT
-*  Complete Legal Terms: http://opensource.org/licenses/MIT
-
-## Plotly
-
-The MIT License (MIT)
-
-Copyright (c) 2016 Plotly, Inc
-
-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.
+# Flammarion
+
+Copyright (c) 2015 Zachary Capalbo
+
+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.
+
+
+# External Packages
+
+Flammarion is bundled with a number of 3rd party packages:
+
+## Font Awesome
+
+This software incorporates
+[Font Awesome by Dave Gandy - http://fontawesome.io](http://fontawesome.io). The
+fonts in Font Awesome are licensed under the
+[SIL OFL 1.1](http://scripts.sil.org/OFL). The css files in Font Awesome are
+licensed under the [MIT License](http://opensource.org/licenses/mit-license.html)
+
+C.f. https://fortawesome.github.io/Font-Awesome/license/
+
+## JQuery
+
+jQuery Foundation projects are released under the terms of the license specified in the project's repository or if not specified, under the [MIT license](https://tldrlegal.com/license/mit-license)
+
+## Highlight JS
+
+Copyright (c) 2006, Ivan Sagalaev
+All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of highlight.js nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## Leaflet
+
+Copyright (c) 2010-2015, Vladimir Agafonkin
+Copyright (c) 2010-2011, CloudMade
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## Rubame
+
+(The MIT License)
+
+Copyright © 2013 Mark Saward
+
+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.
+
+## Twemoji
+
+### Twemoji Artwork
+
+As an open source project, attribution is critical from a legal, practical and motivational perspective in our opinion. The graphics are licensed under the CC-BY 4.0 which has a pretty good guide on best practices for attribution.
+
+However, we consider the guide a bit onerous and as a project, will accept a mention in a project README or an 'About' section or footer on a website. In mobile applications, a common place would be in the Settings/About section (for example, see the mobile Twitter application Settings->About->Legal section). We would consider a mention in the HTML/JS source sufficient also.
+
+### Twemoji Non-Artwork
+
+Copyright (c) 2018 Twitter, Inc and other contributors
+
+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.
+
+## Emoji One Non-Artwork
+
+*  Applies to the Javascript, JSON, PHP, CSS, HTML files, and everything else not covered under the artwork license above.
+*  License: MIT
+*  Complete Legal Terms: http://opensource.org/licenses/MIT
+
+## Plotly
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Plotly, Inc
+
+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.

data/Readme.md

@@ -1,196 +1,197 @@
-# Flammarion GUI Toolkit
-
-[![Gem Version](https://badge.fury.io/rb/flammarion.svg)](https://badge.fury.io/rb/flammarion)
-
-* [Source](https://github.com/zach-capalbo/flammarion)
-* [Documentation](http://zach-capalbo.github.io/flammarion/doc/Flammarion.html)
-
-## Overview
-
-Flammarion is an easy-to-use library for displaying information that you might
-normally display to the command line in a slightly easier-to-access way.
-
-It is not intended to be a full fledged application development toolkit. It is
-intended instead for small scripts where you just want to show some information
-or buttons without going through too much trouble.
-
-## Installation
-
-First, you need to install [electron](http://electron.atom.io/) or [chrome](http://www.google.com/chrome)
-and make sure it's in your path. (*Note:* On Windows, currently only chrome
-works, but you don't need to worry about putting it in your path.)
-
-Then you can install the gem:
-
-```
-gem install flammarion
-```
-
-or add it to your Gemfile.
-
-## Tutorial
-
-The easiest way to use Flammarion, is similar to how you might use STDOUT:
-
-_(Note: these examples are intended to be run from an interactive session such as IRB or [pry](http://pryrepl.org/). If you wish to use them as part of a script, you should use `f.wait_until_closed` at the end, in order to block termination of the script.)_
-
-```ruby
-require 'flammarion'
-f = Flammarion::Engraving.new
-f.puts "Hello World!"
-```
-
-It can even support standard console color codes (Thanks to [ansi_up](http://github.com/drudru/ansi_up)!) and emoji / icons (Thanks to [emojione](http://emojione.com/) and [font awesome](https://fortawesome.github.io/Font-Awesome/))
-
-```ruby
-require 'colorized'
-f.puts "This line will be red!".red
-f.puts "This #{"word".colorize(:green)} will not be blue."
-f.puts "This line will have cows :cow: :cow2:", escape_icons: true
-```
-
-However, you can also do more advanced things. Say you want to show a table. Easy!
-
-```ruby
-f.table(
-  [%w[Number Squared Sqrt].map{|h| h.light_magenta}] + # Make the header a different color
-  10.times.collect{|x| [x, x * x, Math.sqrt(x)]})
-```
-
-Now, instead of a table, you decide you want a plot. No problem.
-
-```ruby
-x = 10.times.to_a
-f.plot([{x:x, y:x}, {x: x, y: x.map{|i| i*i}}, {x: x, y: x.map{|i| Math.sqrt(i)}}])
-```
-
-Or maybe you want to know where something is:
-
-```ruby
-f.map("Boston, MA")
-```
-
-Maybe you even want to see both of those things *at the same time*!
-
-```ruby
-f.pane("numberstuff").table([%w[Number Squared Sqrt].map{|h| h.light_magenta}] +
-  10.times.collect{|x| [x, x * x, Math.sqrt(x)]})
-f.pane("mapstuff").map("Big Ben")
-```
-
-If you need feedback, there's a simple callback mechanism for buttons and text
-boxes:
-
-```ruby
-f.button("Click Here!!!") {f.puts "You clicked the button!"}
-f.input("Placeholder > ") {|msg| f.puts "You wrote: #{msg['text'].light_magenta}"}
-```
-
-The [api documentation](http://zach-capalbo.github.io/flammarion/doc/Flammarion.html)
-is available at <http://zach-capalbo.github.io/flammarion/doc/Flammarion.html>.
-
-## Screenshots / Samples
-
-### Message Composer with Address Book
-
-```ruby
-f = Flammarion::Engraving.new
-f.orientation = :horizontal
-recipient = f.subpane("number").input("Phone Number")
-text = f.input("Body", multiline:true)
-f.button("Send") { send_message(recipient.to_s, text.to_s); f.status("Message Sent!")}
-f.pane("contacts").puts("Contacts", replace:true)
-icons = %w[thumbs-up meh-o bicycle gears star-o star cow cat cactus] + [nil] * 5
-30.times do |i|
-  name = Faker::Name.name
-  f.pane("contacts").button(name, right_icon:icons.sample, left_icon:icons.sample) do
-    recipient = name
-    f.subpane("number").replace(name)
-  end
-end
-```
-
-![Message Sample](http://zach-capalbo.github.io/flammarion/img/message_sender_with_contacts.png)
-
-### Rake Task Runner
-
-```ruby
-f = Flammarion::Engraving.new(exit_on_disconnect:true)
-f.title "frake #{Dir.pwd}"
-
-def run(task)
-  f2 = Flammarion::Engraving.new
-  f2.title task
-  f2.puts "Running #{task.light_magenta}"
-  Open3.popen3(task) do |i,o,e,t|
-    Thread.new {e.each_line{|l| f2.print l.red}}
-    o.each_line {|l| f2.print l}
-    f2.status t.value.success? ? "Done!".light_green : "Failed!".light_red
-  end
-end
-
-f.markdown "# Rake Tasks: "
-`rake -T`.each_line do |l|
-  f.break
-  parts = l.split("#")
-  task = parts[0]
-  desc = parts[1]
-  f.puts desc
-  f.button(task) do
-    run(task)
-  end
-end
-
-f.wait_until_closed
-```
-
-![Frake](http://zach-capalbo.github.io/flammarion/img/frake.png)
-
-### Tables
-
-```ruby
-f = Flammarion::Engraving.new
-f.orientation = :horizontal
-f.table([["Id", "Name", "Address"].map{|h| h.light_magenta}] + 20.times.map do |i|
-  [i, Faker::Name.name, Faker::Address.street_address]
-end)
-f.pane("sidebar").pane("side1").puts Faker::Hipster.paragraph.red
-f.pane("sidebar").pane("side2").puts Faker::Hipster.paragraph.green
-
-3.times { f.status(Faker::Hipster.sentence.light_green)}
-```
-
-![Table Sample](http://zach-capalbo.github.io/flammarion/img/table.png)
-
-```ruby
-f = Flammarion::Engraving.new
-f.plot(5.times.map{|t| {y:100.times.map{rand * t}}})
-```
-
-![Plot Sample](http://zach-capalbo.github.io/flammarion/img/plot.png)
-
-## Examples
-
-There are a number of useful examples in the [examples directory.](https://github.com/zach-capalbo/flammarion/tree/master/examples)
-
-Some of these examples can be quite handy in their own right. If you wish to
-install these as executables, you can install the `flammarion-utils` gem with
-the command
-
-```bash
-gem install flammarion-utils
-```
-
-# Bundled Packages
-
-Flammarion is distributed with a bunch of useful tools to make everyone's life easier.
-They are:
-
- * [ansi up](https://github.com/drudru/ansi_up)
- * [highlight.js](https://highlightjs.org/)
- * [jquery](https://jquery.com/)
- * [jquery transit](http://ricostacruz.com/jquery.transit/)
- * [leaflet](http://leafletjs.com/)
- * [font awesome](https://fortawesome.github.io/Font-Awesome/)
- * [emojione](http://emojione.com/)
- * [Plotly](https://plot.ly/)
+# Flammarion GUI Toolkit
+
+[![Gem Version](https://badge.fury.io/rb/flammarion.svg)](https://badge.fury.io/rb/flammarion)
+
+* [Source](https://github.com/zach-capalbo/flammarion)
+* [Documentation](http://zach-capalbo.github.io/flammarion/doc/Flammarion.html)
+
+## Overview
+
+Flammarion is an easy-to-use library for displaying information that you might
+normally display to the command line in a slightly easier-to-access way.
+
+It is not intended to be a full fledged application development toolkit. It is
+intended instead for small scripts where you just want to show some information
+or buttons without going through too much trouble.
+
+## Installation
+
+First, you need to install [electron](http://electron.atom.io/) or [chrome](http://www.google.com/chrome)
+and make sure it's in your path. (*Note:* On Windows, currently only chrome
+works, but you don't need to worry about putting it in your path.)
+
+Then you can install the gem:
+
+```
+gem install flammarion
+```
+
+or add it to your Gemfile.
+
+## Tutorial
+
+The easiest way to use Flammarion, is similar to how you might use STDOUT:
+
+_(Note: these examples are intended to be run from an interactive session such as IRB or [pry](http://pryrepl.org/). If you wish to use them as part of a script, you should use `f.wait_until_closed` at the end, in order to block termination of the script.)_
+
+```ruby
+require 'flammarion'
+f = Flammarion::Engraving.new
+f.puts "Hello World!"
+```
+
+It can even support standard console color codes (Thanks to [ansi_up](http://github.com/drudru/ansi_up)!) and emoji / icons (Thanks to [tweomji](https://github.com/twitter/twemoji) and [font awesome](https://fortawesome.github.io/Font-Awesome/))
+
+```ruby
+require 'colorized'
+f.puts "This line will be red!".red
+f.puts "This #{"word".colorize(:green)} will not be blue."
+f.puts "This line will have cows :cow: :cow2:", escape_icons: true
+```
+
+However, you can also do more advanced things. Say you want to show a table. Easy!
+
+```ruby
+f.table(
+  [%w[Number Squared Sqrt].map{|h| h.light_magenta}] + # Make the header a different color
+  10.times.collect{|x| [x, x * x, Math.sqrt(x)]})
+```
+
+Now, instead of a table, you decide you want a plot. No problem.
+
+```ruby
+x = 10.times.to_a
+f.plot([{x:x, y:x}, {x: x, y: x.map{|i| i*i}}, {x: x, y: x.map{|i| Math.sqrt(i)}}])
+```
+
+Or maybe you want to know where something is:
+
+```ruby
+f.map("Boston, MA")
+```
+
+Maybe you even want to see both of those things *at the same time*!
+
+```ruby
+f.pane("numberstuff").table([%w[Number Squared Sqrt].map{|h| h.light_magenta}] +
+  10.times.collect{|x| [x, x * x, Math.sqrt(x)]})
+f.pane("mapstuff").map("Big Ben")
+```
+
+If you need feedback, there's a simple callback mechanism for buttons and text
+boxes:
+
+```ruby
+f.button("Click Here!!!") {f.puts "You clicked the button!"}
+f.input("Placeholder > ") {|msg| f.puts "You wrote: #{msg['text'].light_magenta}"}
+```
+
+The [api documentation](http://zach-capalbo.github.io/flammarion/doc/Flammarion.html)
+is available at <http://zach-capalbo.github.io/flammarion/doc/Flammarion.html>.
+
+## Screenshots / Samples
+
+### Message Composer with Address Book
+
+```ruby
+f = Flammarion::Engraving.new
+f.orientation = :horizontal
+recipient = f.subpane("number").input("Phone Number")
+text = f.input("Body", multiline:true)
+f.button("Send") { send_message(recipient.to_s, text.to_s); f.status("Message Sent!")}
+f.pane("contacts").puts("Contacts", replace:true)
+icons = %w[thumbs-up meh-o bicycle gears star-o star cow cat cactus] + [nil] * 5
+30.times do |i|
+  name = Faker::Name.name
+  f.pane("contacts").button(name, right_icon:icons.sample, left_icon:icons.sample) do
+    recipient = name
+    f.subpane("number").replace(name)
+  end
+end
+```
+
+![Message Sample](http://zach-capalbo.github.io/flammarion/img/message_sender_with_contacts.png)
+
+### Rake Task Runner
+
+```ruby
+f = Flammarion::Engraving.new(exit_on_disconnect:true)
+f.title "frake #{Dir.pwd}"
+
+def run(task)
+  f2 = Flammarion::Engraving.new
+  f2.title task
+  f2.puts "Running #{task.light_magenta}"
+  Open3.popen3(task) do |i,o,e,t|
+    Thread.new {e.each_line{|l| f2.print l.red}}
+    o.each_line {|l| f2.print l}
+    f2.status t.value.success? ? "Done!".light_green : "Failed!".light_red
+  end
+end
+
+f.markdown "# Rake Tasks: "
+`rake -T`.each_line do |l|
+  f.break
+  parts = l.split("#")
+  task = parts[0]
+  desc = parts[1]
+  f.puts desc
+  f.button(task) do
+    run(task)
+  end
+end
+
+f.wait_until_closed
+```
+
+![Frake](http://zach-capalbo.github.io/flammarion/img/frake.png)
+
+### Tables
+
+```ruby
+f = Flammarion::Engraving.new
+f.orientation = :horizontal
+f.table([["Id", "Name", "Address"].map{|h| h.light_magenta}] + 20.times.map do |i|
+  [i, Faker::Name.name, Faker::Address.street_address]
+end)
+f.pane("sidebar").pane("side1").puts Faker::Hipster.paragraph.red
+f.pane("sidebar").pane("side2").puts Faker::Hipster.paragraph.green
+
+3.times { f.status(Faker::Hipster.sentence.light_green)}
+```
+
+![Table Sample](http://zach-capalbo.github.io/flammarion/img/table.png)
+
+```ruby
+f = Flammarion::Engraving.new
+f.plot(5.times.map{|t| {y:100.times.map{rand * t}}})
+```
+
+![Plot Sample](http://zach-capalbo.github.io/flammarion/img/plot.png)
+
+## Examples
+
+There are a number of useful examples in the [examples directory.](https://github.com/zach-capalbo/flammarion/tree/master/examples)
+
+Some of these examples can be quite handy in their own right. If you wish to
+install these as executables, you can install the `flammarion-utils` gem with
+the command
+
+```bash
+gem install flammarion-utils
+```
+
+# Bundled Packages
+
+Flammarion is distributed with a bunch of useful tools to make everyone's life easier.
+They are:
+
+ * [ansi up](https://github.com/drudru/ansi_up)
+ * [highlight.js](https://highlightjs.org/)
+ * [jquery](https://jquery.com/)
+ * [jquery transit](http://ricostacruz.com/jquery.transit/)
+ * [leaflet](http://leafletjs.com/)
+ * [font awesome](https://fortawesome.github.io/Font-Awesome/)
+ * [twemoji](https://github.com/twitter/twemoji)
+ * [emojione v2](https://github.com/emojione/emojione/releases/tag/v2.2.7)
+ * [Plotly](https://plot.ly/)