gv 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdabad8208f3857d6f16f16b5db3d7e005def7a2
-  data.tar.gz: 5e9d9f1993de38f9e43b80ac61e3f8d75e37c9c4
+  metadata.gz: 3ab9a6ec4d306435db96592402c93d4e2746815d
+  data.tar.gz: 141d01be0f201f81285c758d217df94d0d34d17e
 SHA512:
-  metadata.gz: 8f74f1b224cf335ad1f9328379b1de48d176c169d82499faabe0fe9a2661791b62576dc7540d40719d1e79f4f474c2afbbf99a89263f6e8264b78609cecefaa8
-  data.tar.gz: 680ecfbd1bd2dd1269aaa43706eaa1f7513c1c9249c234e85bbabdeae61b426d05d2c428aba36043aaeb810c3f4f7049c3bc446e304cf810f8465b162f545ca1
+  metadata.gz: 8d1128773dee3e2b1d7a7ea29d1201247cb74ed8bc65e2f75cfbe2eedc00939aa4becd1041061718e171fa0b693689fb7ae331e0d7b5eee83471b8bdca83f8c8
+  data.tar.gz: d891316e6792c0be6f6821f81c6b1d3e05bc63fca2b5e897641efb7087ed17af5cb94e326d2f593f8d75826024b3bd3131d3f90d0abe3e9d93c5e2402f2955be

data/README.md

@@ -1,6 +1,6 @@
 # GV
 
-TODO: Write a gem description
+Ruby bindings for libgvc (Graphviz) using FFI.
 
 ## Installation
 
@@ -20,11 +20,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create new graph:
+```ruby
+require 'gv'
+
+graph = GV::Graph.open 'g'
+graph.edge 'e', graph.node('A'), graph.node('B', shape: 'polygon')
+
+# render to string
+graph.render 'png'
+
+# or to a file
+graph.write 'result.png'
+```
+
+#### Result 
+![resilt](/spec/render.png)
+  
+### Load existing graph from `.dot` file:
+```ruby
+require 'gv'
+
+graph = GV::Graph.load File.open('g.dot')
+
+# render graph
+graph.render
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/gv/fork )
+1. Fork it ( https://github.com/furunkel/gv/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/gv.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = GV::VERSION
   spec.authors       = ["furunkel"]
   spec.email         = ["julian@linux4you.it"]
-  spec.summary       = %q{Graphviz for Ruby, using libgvc directly via FFI}
+  spec.summary       = %q{Graphviz for Ruby, using libgvc via FFI}
   spec.homepage      = "https://github.com/furunkel/gv"
   spec.license       = "MIT"
 

data/lib/gv/version.rb

@@ -1,3 +1,3 @@
 module GV
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gv
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - furunkel
@@ -108,7 +108,7 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Graphviz for Ruby, using libgvc directly via FFI
+summary: Graphviz for Ruby, using libgvc via FFI
 test_files:
 - spec/graph_spec.rb
 - spec/render.png