docrails_kindle 0.0.2 → 0.0.3

data/README.markdown

@@ -1,10 +1,28 @@
 # docrails_kindle
 
-This gem lets you generate a Kindle version of the [Ruby on Rails Guides][railsguide] with 
-working section and article navigation.
+This gem lets you generate a Kindle version of the [Ruby on Rails
+Guides][railsguide] with working section and article navigation.
 
 [railsguide]:http://guides.rubyonrails.org/
 
+![screen](https://github.com/danchoi/docrails_kindle/raw/master/images/screen1-sm.gif)
+
+The DocRails project does provide its own experimental Rake task to generate a
+Kindle version of the Rails Guides. However, its section and article
+navigation doesn't work correctly (at least on a Kindle Touch).
+
+## Download Guide
+
+If you just want to download the ebook I generated with this tool, here it is:
+
+[Download Rails Guides ebook][mobi]
+
+[mobi]:https://github.com/danchoi/docrails_kindle/raw/master/mobi/rails-guide.2012-01-18.mobi
+
+But to keep up with updates to the Rails Guides, you may want to periodically
+generate the Rails Guides ebook yourself. For this, please read on.
+
+
 ## Install
 
     gem install docrails_kindle
@@ -26,7 +44,7 @@ Download [KindleGen 2][kindlegen] and put it on your PATH.
     
 The output document will be called something like
 `rails-guide.2012-11-18.mobi`. Don't confuse it with the other mobi document
-that gets generated by `rake genereate_guides`, which looks like
+that gets generated by `rake generate_guides`, which looks like
 `ruby_on_rails_guides_16c5f48.mobi`.
   
 You can transfer this mobi file to your Kindle.
@@ -34,11 +52,12 @@ You can transfer this mobi file to your Kindle.
 
 ## Contribute
 
-This program is a rough prototype. Some internal links may not work. Other
-defects in the resulting ebook may exist. Please file issues.
+This program is a rough prototype. Some internal links may not work. The css
+styling may need to be improved. Other bugs may exist. Please file issues or
+fork and submit pull requests.
 
-Also, if the `docsrails` team would like to incorporate this into their
-`rake` tasks code, please take and modify my code as you see fit.
+Also, if the DocsRails team would like to incorporate and adapt this code for
+their project, please go for it. 
 
 
 ## Author

data/bin/docrails_kindle

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-# take toc.ncx
-
 require 'nokogiri'
 require 'fileutils'
 require 'yaml'
@@ -94,7 +92,7 @@ x = Nokogiri::XML(File.open("rails_guides.opf")).remove_namespaces!
 
 document = {
   'doc_uuid' => x.at("package")['unique-identifier'],
-  'title' => x.at("title").inner_text,
+  'title' => x.at("title").inner_text.gsub(/\(.*$/, " v2"),
   'publisher' => x.at("publisher").inner_text,
   'author' => x.at("creator").inner_text,
   'subject' => x.at("subject").inner_text,

data/docrails_kindle.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "docrails_kindle"
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 1.9.0'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docrails_kindle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &21775660 !ruby/object:Gem::Requirement
+  requirement: &23725740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21775660
+  version_requirements: *23725740
 - !ruby/object:Gem::Dependency
   name: kindlerb
-  requirement: &21775180 !ruby/object:Gem::Requirement
+  requirement: &23725280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21775180
+  version_requirements: *23725280
 description: Read Rails Guides for your Kindle
 email:
 - dhchoi@gmail.com