autoaudio 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 171b6ac2299bc99f246e08efe0f9dcb6cd65c86d
-  data.tar.gz: 4ff98406573ab4a6f98041f92e0c50fd7550bb8f
+  metadata.gz: 3ebcc0700385f757436c2c56134f89ec023ec7b3
+  data.tar.gz: ee6bb054f99f8c3c907eddba21fdc5c48ff677a8
 SHA512:
-  metadata.gz: f5eb67480752847ebc713230c708cdf36aac0690ed30339380c3fab6820f70a8c11ebc306c0ea951c250754bf3c12786315f2896a3f5bf119e8a5024ebd40046
-  data.tar.gz: fe4b1a730c4875c65a98341f72d8366d8d67c4be14acc2e8ba5d14759d7d01c020279aedc1c3096b600b55d3e489b917ac459610081e3a3c2ed4c51ee1cc0495
+  metadata.gz: ee9c1f69081303bcaeded74a99762d201fdc768600e802e4f989b0cbdd23fd2d0c5aba687767883ff453d23383e49ff566c0a6e52acc4b78a99838d5d314c2c1
+  data.tar.gz: 21040aebc98ddfacd0f5c804d37e607593ba4ae436cf73aa5f8faf4f2dd8be47966a1f080bb7cc840fe8e92e1e0448aae826b4a23f40d054939a89fb273736ed

data/README.md

@@ -1,11 +1,8 @@
 # Autoaudio
 
-
-## THESE INSTRUCTIONS ARE NO LONGER VALID. ```audioaudio list``` for a list of commands. Proper readme coming soon.
-
 ### It's ugly as hell, but it 100% works.
 
-![alt text](https://raw.github.com/GeneLocklin/autoaudio/master/etc/aa.jpg "Autoaudio")
+![alt text](https://raw.githubusercontent.com/GeneLocklin/autoaudio/master/images/aa.jpg "Autoaudio, bitches!")
 
 Autoaudio parses [http://nfodb.net.ru/rss.php](http://nfodb.net.ru/rss.php) for the latest Scene audio releases. Then, it queries [http://nzbindex.nl/](http://nzbindex.nl/) for the release and creates a `.nzb`.
 
@@ -15,21 +12,39 @@ Releases are sorted by genre and album title and folders are created which hold
 
   * [mechanize](https://github.com/sparklemotion/mechanize/)
   * [mongoid](https://github.com/mongoid/mongoid)
+  * [retries](https://github.com/ooyala/retries)
   * [gist](https://github.com/defunkt/gist)
   * [thor](https://github.com/erikhuda/thor)
   * and, indirectly, [t](https://github.com/sferik/t)
 
 ## Basic Usage:
 
-Run `Thor list` for a list of basic commands.
+Run `autoaudio list` for a list of basic commands.
+
+## Advanced Usage:
+
+Autoaudio requires a few bits of info from you, before it will run correctly.
+
+Before you do anything, run ```autoaudio setup setup```. This will open ```config/settings.rb``` in your editor of choice. Enter info, then save the file.
+
+```ruby
+  download_location    "#{Dir.home}/Downloads/Albums" #=> This is where you want to download the nfo and nzb files.
+  maximum_retention    900                            #=> This is the max retention of your usenet server.
+  nzb_client           'Unison.app'                   #=> This isn't in use, at the moment.
+  zip_files            true                           #=> Do you want to zip the nfo and nzb files together?
+  share_files          true                           #=> Upload zips to anonfiles?
+  tweet_files          true                           #=> Do you want to tweet the uploaded url's?
+  twitter_username     'usenetdecoded'                #=> Twitter username - whatever you have T setup to tweet as.
+```
 
 ## To do:
 
+  * IRC integration - let's go straight to the source
   * help
   * write a more understandable readme
   * add more thor commands as well as more and better descriptions
   * clean up the code - at the moment, it's a huge ball of crap
-  * error handling
+  * better error handling
   * multithreading
   * tests
   * include a launchd plst for for running locally

data/config/settings.rb

@@ -2,12 +2,12 @@ require 'autoaudio'
 
 module Autoaudio
   Settings.config do
-    download_location    "#{Dir.home}/Downloads/Test/Albums"
-    maximum_retention    900
-    nzb_client           'Unison.app'
-    zip_files            true
-    share_files          true
-    tweet_files          true
-    twitter_username     'usenetdecoded'
+  download_location    "#{Dir.home}/Downloads/Albums" #=> This is where you want to download the nfo and nzb files.
+  maximum_retention    900                            #=> This is the max retention of your usenet server.
+  nzb_client           'Unison.app'                   #=> This isn't in use, at the moment.
+  zip_files            true                           #=> Do you want to zip the nfo and nzb files together?
+  share_files          true                           #=> Upload zips to anonfiles?
+  tweet_files          true                           #=> Do you want to tweet the uploaded url's?
+  twitter_username     'usenetdecoded'                #=> Twitter username - whatever you have T setup to tweet as.
   end
 end

data/lib/autoaudio/version.rb

@@ -1,3 +1,3 @@
 module Autoaudio
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: autoaudio
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Gene Locklin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize