bdoc 0.3.0 → 0.3.1

data/History.txt

@@ -1,3 +1,8 @@
+== 0.3.1 2011-03-14
+
+* 1 minor enhancement
+  * Updated README
+
 == 0.3.0 2011-03-13
 
 * 3 new features

data/README.rdoc

@@ -1,10 +1,8 @@
 = Bdoc
 
-* http://github.com/manalang/bdoc
+== Description
 
-== DESCRIPTION:
-
-Bdoc is a simple replacement for gem server.  All it does is look at all of
+Bdoc is a simple replacement for the gem or yard server.  All it does is look at all of
 the Gems you have installed locally and creates a nice iframe based
 browser that makes it easy to navigate between gem docs. IT DOES NOT REQUIRE
 A SERVER FOR VIEWING... not like gem server does!
@@ -12,13 +10,13 @@ A SERVER FOR VIEWING... not like gem server does!
 If you use this, I highly suggest also using 
 Hanna[http://github.com/mislav/hanna/tree/master] (a beautiful rdoc theme).
 
-Check out the demo http://manalang.github.com/bdoc
+Check out the demo http://manalang.github.com/bdoc/bdoc.html
 
-http://img.skitch.com/20090406-8bhnftitwtrpd5xeu4acexerm6.png
+http://img.skitch.com/20110314-1xgsk2prxisirifc923fwb7htc.png
 
 == Install
 
-  [sudo] gem install manalang-bdoc
+  [sudo] gem install bdoc
 
 == Usage
 
@@ -33,11 +31,27 @@ Optionally you can specify the output directory on the command line:
 
   bdoc /path/to/bdoc
 
+== Bonus
+
+To improve your Bdoc experience, I highly recommend you install the Hanna gem
+
+  [sudo] gem install hanna
+
+This will make your Rdocs looks so much better. After you install Hanna, you'll
+need to rebuild all of your Rdocs. In order to do that, add this to your ~/.gemrc:
+
+  rdoc: --inline-source --line-numbers --format=html --template=hanna
+
+...then rebuild:
+
+  [sudo] gem rdoc --all --overwrite --no-ri
+
+
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 Rich Manalang
+Copyright (c) 2011 Rich Manalang
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/bdoc.rb

@@ -8,7 +8,7 @@ require 'launchy'
 require 'multi_json'
 
 module Bdoc
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 
   class << self
     attr_accessor :output_dir

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bdoc
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Rich Manalang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-12 23:00:00 -08:00
+date: 2011-03-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,7 +67,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 description: |-
-  Bdoc is a simple replacement for gem server.  All it does is look at all of
+  Bdoc is a simple replacement for the gem or yard server.  All it does is look at all of
   the Gems you have installed locally and creates a nice iframe based
   browser that makes it easy to navigate between gem docs. IT DOES NOT REQUIRE
   A SERVER FOR VIEWING... not like gem server does!
@@ -75,9 +75,9 @@ description: |-
   If you use this, I highly suggest also using 
   Hanna[http://github.com/mislav/hanna/tree/master] (a beautiful rdoc theme).
   
-  Check out the demo http://manalang.github.com/bdoc
+  Check out the demo http://manalang.github.com/bdoc/bdoc.html
   
-  http://img.skitch.com/20090406-8bhnftitwtrpd5xeu4acexerm6.png
+  http://img.skitch.com/20110314-1xgsk2prxisirifc923fwb7htc.png
 email: 
 - rich.manalang@gmail.com
 executables: 
@@ -99,7 +99,7 @@ files:
 - test/test_helper.rb
 - .gemtest
 has_rdoc: true
-homepage: http://github.com/manalang/bdoc
+homepage: 
 licenses: []
 
 post_install_message: PostInstall.txt
@@ -132,7 +132,7 @@ rubyforge_project: bdoc
 rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
-summary: Bdoc is a simple replacement for gem server
+summary: Bdoc is a simple replacement for the gem or yard server
 test_files: 
 - test/test_bdoc.rb
 - test/test_helper.rb