speaker 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,13 @@
 # Speaker
 
-Flexible text to speech using Google Translator
+Flexible text to speech using Google Translator.
+
+One nice touch of Speaker is that you can transform *texts of any size* to audio. 
+Google Translator API limits texts to 100 characters. Speaker deals with that for you.
+
+But, of course, good sense is always appreciated. The longer the text is, the longer will take to transform it to audio.
+
+All said, enjoyt it!
 
 ## Installation
 
@@ -18,7 +25,81 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+All you need to start is to create a new Speaker object passing the text you want to transform in audio:
+
+```ruby
+speaker = Speaker.new(text: "My name is Bond. James Bond")
+```
+
+Now you can just do "text to speech":
+
+```ruby
+speaker.tts # It will say "My name is Bond. James Bond"
+```
+
+If you want to listen it again:
+
+```ruby
+speaker.play # Do not create the audio again. Instead, just play it.
+```
+
+If you want, you can create the audio and play it in two steps. (This is exactly what the tts method does):
+
+```ruby
+speaker.to_audio # Creates the audio
+speaker.play # Play it
+```
+
+Whenever a new Speaker object is created, there is no more audio file to play until you want it. So, if you create a new Speaker object and try to play it, there will be no audio file to play and Speaker will let you know that:
+
+```ruby
+speaker = Speaker.new
+speaker.play # It will return the string: "There is no audio file yet"
+```
+
+You can check if there is an audio file by typing:
+
+```ruby
+speaker.has_audio? # It returns true or false
+```
+
+You can create and play you text in one line by doing:
+
+```ruby
+Speaker.new(text: "My name is Bond. James Bond").tts
+```
+
+By default, the audio file will be created inside the root path where the gem is running. But, of course, you can change it:
+
+```ruby
+Speaker.configure do |config|
+  config.audio_file_path = '/new/path' # i.e.: /myapp/media
+end
+```
+
+To check what is the current audio file path:
+
+```ruby
+Speaker.configuration.audio_file_path
+```
+
+If you want to create tts in anothers languages:
+
+```ruby
+speaker = Speaker.new(language: 'pt', text: 'Olá meu amigo')
+speaker.tts # It will say 'Olá meu amigo', which is 'Hello my friend' in portuguese.
+```
+
+If you want to return the text and the language:
+
+```ruby
+speaker.text # It will return 'Olá meu amigo'
+speaker.language # I will return 'pt'
+```
+
+English is the default language.
+
+If you create a new Speaker object without passing any information, Speaker will create an object with the text 'Nothing to say'.
 
 ## Contributing
 

data/lib/speaker.rb

@@ -13,7 +13,7 @@ module Speaker
     yield(configuration)
   end
   
-  def self.new(params)
+  def self.new(params={})
   	Base.new(params)
   end
   

data/lib/speaker/base.rb

@@ -39,7 +39,7 @@ module Speaker
 
 		def play
 			if has_audio?
-				`afplay #{audio_file}`
+				`#{player} #{audio_file}`
 				@text
 			else
 				"There is no audio file yet"
@@ -123,6 +123,14 @@ module Speaker
 			File.delete(audio_file) if has_audio?
 	  end
 
+	  def player
+	  	if RUBY_PLATFORM.include?("darwin")
+	  		'afplay'
+	  	else
+	  		'mpg123'
+	  	end
+	  end
+
   end
 
 end

data/lib/speaker/version.rb

@@ -1,3 +1,3 @@
 module Speaker
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: speaker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.1
 description: Flexible text to speech using Google Translator
 email:
 - david@webhall.com.br
@@ -41,7 +41,7 @@ files:
 - LICENSE
 - Rakefile
 - README.md
-homepage: ''
+homepage: https://github.com/davidwilliam/speaker
 licenses: []
 post_install_message: 
 rdoc_options: []