documentize 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83c8d3155a3a0504b9e6879cbaa4a0cbd1b201eb
-  data.tar.gz: d4be67def28761871093360b82a632b931d82077
+  metadata.gz: 36c3ea291baa8735c7b8bc3eb5888fb8907c016f
+  data.tar.gz: 5b7c99220c8fd2d45dfa44066a72508fb78b117d
 SHA512:
-  metadata.gz: bee1b5899df407d4736d6d28b24827918c82abcbdf98744d879b1b6408cfa7a3aec0ab5e47a1a39c3121aada3345a18c291a53a6989ad7847618738dd3eef9bc
-  data.tar.gz: 7ffcdffe1d8286b6d2a8630840af336afde0a5e3cb0241cd85d65e05c144b578283784a4545f0aa8be58d951ba48c1c1b8b04c93a502e26e78c7afabb67b3577
+  metadata.gz: 7b4e5c4c8632b0ada05c9d49a1c620598ed84f30046d2aa0803e9ca58727750792257113613b511041720aae7cc9e2790e99234b16bc5fda98452fa7a702811d
+  data.tar.gz: 024add8f810c2977ecadf7e4a178f01f4f71510d65b3d11be874c8b9ef8d43041bfbb87ff34a2dc7d37e5cab42825673e66905c279d97571858d4e9a599eb852

data/README.md

@@ -1,41 +1,27 @@
 # Documentize
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/documentize`. To experiment with that code, run `bin/console` for an interactive prompt.
+generates a ruby file with a TomDoc skeletons from existing ruby files
 
-TODO: Delete this and the text above, and describe your gem
+Pass in a cluttered, or just undocumented ruby file and get back a well-spaced file with a TomDoc Skeleton for easy doc writing
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'documentize'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+run the following in your console:
 
     $ gem install documentize
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
+Documentize takes any ruby file as an argument in the CLI, relative to you current working directory:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake true` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ documentize my_ruby_file.rb
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/documentize.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/SampsonCrowley/documentize](https://github.com/SampsonCrowley/documentize)
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/documentize/builder.rb

@@ -35,7 +35,7 @@ module Documentize
       str = ""
       str << build_docs(code, indent) if code[:doc]
       str << "  "*indent
-      str << "#{code[:type]} #{code[:name]}"
+      str << "#{code[:type] == "method" ? "def" : code[:type]} #{code[:name]}"
       str << build_args(code[:args]) if code[:args]
       str << "\n\n"
 

data/lib/documentize/version.rb

@@ -1,3 +1,3 @@
 module Documentize
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: documentize
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Sampson Crowley