visualize_inheritance 0.0.12 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6b9a0df7c61e83058ea538b61a5bfaa6e99faaf
-  data.tar.gz: 3a72edf40432dc25138f203c1e5503ad09067a63
+  metadata.gz: 075959c5cdbfdd536bcb46d24dffb2a76891d569
+  data.tar.gz: f68196e37f6bb42acf1ae27ceaf905723a9db9d8
 SHA512:
-  metadata.gz: 5804b58c706f1a467e0257e6a45ec22396ef7f380ccbfdd9de7b5016c29d7d9f80b2fd447c487970fbe654a9047562b9ec255e788e3428390117e5c8b802d5e8
-  data.tar.gz: 21f9a30f07239393b81d6602a0fdffe5f80d7fcf2bc6d223b40f27aa642b81b595cd5d20c268877867e2a3a101886a8068c69583ec9ae0a30be7b76d19aa58a3
+  metadata.gz: 3eebeeb37f89107d3fc012fcaeb5e227425a64c8dc4a554df60ad4cabf1c097863e2bf8f53301f08ad5e04f0f0708bd12c2b10c218ba4239d5bd94a733c7c89f
+  data.tar.gz: c2664fe66ec7ff1745374c4ab1e94fa4e57b2bb35e559c5a5924d0f802180747d4b94b61ba30770fce0ee2b839089da62a8577eea3e7e6f96e0563335a018cfc

data/README.md

@@ -1,7 +1,7 @@
 
 # VisualizeInheritance
 
-TODO: Write a gem description
+VisualizeInheritance is a gem that creates a visualization of the class structure of an app. It couples a simple Bash script and a D3 force directed graph through Ruby.
 
 ## Installation
 
@@ -19,20 +19,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In order to create a visualization of the class structure, first, create a ruby script in the home directory. Add the following lines to the script:
+
+	$ VisualizeInheritance.csv
+	$ VisualizeInheritance.write_index
+	$ VisualizeInheritance.graph
+
+Then, run the ruby script. It will create a force directed graph in a new browser window.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/visualize_inheritance/fork )
+1. Fork it ( https://github.com/cmvandrevala/visualize_inheritance/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`)
 5. Create a new Pull Request
-
-
-Visualizing Inheritance Structure in Ruby
-=========================================
-
-This code uses a simple Bash script combined with a force directed graph in D3 to visualize the inheritance structure of a Ruby project.
-
-Put this in the main folder of the project.  Upon running the bash script create_graph.sh, it will scan the lib folder for all classes, and then create a force directed graph in a browser window using D3.

data/lib/visualize_inheritance/version.rb

@@ -1,3 +1,3 @@
 module VisualizeInheritance
-  VERSION = "0.0.12"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: visualize_inheritance
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 1.0.0
 platform: ruby
 authors:
 - Cyrus Vandrevala