dickens 0.1.1 → 0.2.1

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+##v0.2.1
+*fixed inclusion bug and added readme
 ##v0.1.1
 *Provided simple api for useing StarDict console version
 

data/README.md

@@ -1,14 +1,65 @@
 #Dickens
 
+`gem install dickens`
+
 ## SDCV installation
+### Linux
+
+```sh
+  sudo apt-get install sdcv
+```
+
+### MacOS
+In Mac OS it is possible to install SDCV using Ports:
+
+```sh
+  port install sdcv
+```
+
+### Dictionaries
+Lots of dics may be found across the net. The starting point may be (here)[http://www.stardict.org/download.php]
+#### Install dictionaries on Linux
+
+```sh
+  tar -xjvf a.tar.bz2
+  mv a /usr/share/stardict/dic
+```
 
 ## API methods
 ### List
+After everything is installed you can list the dictionaries:
+
+```ruby
+  Dickens::StarDict.list
+```
 
 ### Find
+You can lookup desired definition through all dics at once:
+
+```ruby
+  Dickens::StarDict.find("Dickens")
+```
 
 ### Where
+Define dictionaries to lookup only inside those dics:
+```ruby
+  list=Dickens::StarDict.list
+  Dickens::StarDict.where("Dickens", [list[1], list[3]])
+```
 
 ### Configuration
+Change the path to executable:
+```ruby
+  Dickens::StarDict.executable = "./lib/my_sdcv"
+```
+
+Control your options
+```ruby
+  Dickens::StarDict.config :use_dict => false,
+                           :utf8_input => true,
+                           :utf8_output => true,
+                           :non_interactive => true,
+                           :data_dir=>false
+```
 
 

data/lib/dickens.rb

@@ -1,7 +1,4 @@
 require "dickens/version"
-require "dickens/dickens"
-require "dickens/list_items"
-require "dickens/find_items"
 
 require 'rbconfig'
 require RbConfig::CONFIG['target_os'] == 'mingw32' && !(RUBY_VERSION =~ /1.9/) ? 'win32/open3' : 'open3'
@@ -14,6 +11,10 @@ rescue LoadError
   require 'active_support/core_ext/blank'
 end
 
+require "dickens/dickens"
+require "dickens/list_items"
+require "dickens/find_items"
+
 class Object
   ##
   #   @person ? @person.name : nil

data/lib/dickens/dickens.rb

@@ -11,6 +11,9 @@ module Dickens
     }
     cattr_accessor :config, :executable
 
+    def self.config(hash)
+      @@config.merge!(hash)
+    end
 
     ##Использование:
     #    sdcv [ПАРАМЕТР...]  words

data/lib/dickens/version.rb

@@ -1,3 +1,3 @@
 module Dickens
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dickens
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70205088649280 !ruby/object:Gem::Requirement
+  requirement: &70177767292200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205088649280
+  version_requirements: *70177767292200
 description: For now you can gather all your dictionaries together and search through
   them getting pretty rails-style records back
 email: