Merge pull request #26 from citelao/feature-packal

Preparing for Packal integration

CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog #
+
+## v0.9 ##
+
+- Added: created changelog
+- Added: error reporting
+- Added: context-based searching
+- Added: README in Alfred.
+- Added: Packal support
+- Changed: restructured to use Composer
+- Changed: divided Alfred output code into `OhAlfred`
+- Changed: uses more extensible menu system.
+- Removed: Alleyoop support
+- Removed: album art (as I never use it and it was becoming increasingly untested)
+
+## v0.8 ##
+- Added: new icons; set them as default
+
+## v0.7 ##
+- Added: artist- and album-specific menus
+- Changed: general code clean-up
+
+## v0.6 ##
+- Added: Alleyoop support
+
+## v0.5 ##
+- Added: menu system
+
+## v0.1 ##
+- Added: initial search system

README.md

@@ -4,48 +4,45 @@
 ![The magical interface](https://dl.dropboxusercontent.com/u/3770885/Spotifious%20Stuff/hero%20shot.png)
 
 So, you've heard of **Spotifious**, eh? *A natural Spotify controller for
-Alfred*? Searchs Spotify, controls your music, generally rocks?
+Alfred*? Searches Spotify, controls your music, generally rocks?
 
 It's built off a lot of other people's work—
 [PHPFunk](https://github.com/phpfunk/alfred-spotify-controls) and
 [David Ferguson](http://jdfwarrior.tumblr.com/) especially— and tries to match
 the functionality of Alfred's integrated iTunes player. It's not perfect, but it does the job. And I think it's pretty cool.
 
-It uses a slightly modified [Entypo](http://www.entypo.com/) icon font face for icons.
-
 ## Features ##
 
 A quick rundown of its coolness:
 
 ### A controller, not a workflow ###
 
 Spotifious just *feels* fun to use, like a real plugin for Alfred, not a workflow. It
-can do in-depth, album-scouring searches and gives you useful information.
+can do in-depth, album-scouring searches and gives you useful information even if something goes wrong.
+
 Not unlike the iTunes Mini Player.
 
 ### Alfred-like ###
 
-Spotifious is also especially Alfred-like. Just start typing to scour Spotify's
-servers for Music. Browse through artists and albums like nobody's business using an intelligent menu system that leaves you in control.
+Spotifious is also especially Alfred-like. Just start typing to scour Spotify's servers for music. Browse through artists and albums like nobody's business  and drill down through Queen's huge anthologies with a snappy context-based search.
 
 ### Smart ###
 
-Spotifious implements auto-updater Alleyoop to make sure it's always up-to-date.
-It gives you a heads-up about what's going on with Spotify *the moment you
-start it*. It also got a perfect score on its SATs.
+Spotifious uses Packal to make sure you always have the latest version. It gives you a heads-up about what's going on with Spotify *the moment you
+start it*. And don't worry about errors— we'll handle those.
 
 ## Download & Install ##
 
-Current version: v0.81
+Latest version: [v0.9](https://github.com/citelao/Spotify-for-Alfred/archive/master.zip) | Latest dev build: [v0.9](https://github.com/citelao/Spotify-for-Alfred/archive/dev.zip)
 
 1. [Download](https://github.com/citelao/Spotify-for-Alfred/archive/master.zip)
 this repository.
-2. Open `spotifious.alfredworkflow` by double-clicking it or dragging it into
+2. Open `Spotifious.alfredworkflow` by double-clicking it or dragging it into
 Alfred.
 3. Double-click the thingy marked `Hotkey` (fig. i1).
 4. Click the textfield labeled `Hotkey` and press `^⌘⏎`.
 5. Click `Save` to store the binding (fig. i2).
-6. Continue on with your merry day.
+6. Continue on with your merry day— but now with Spotifious.
 
 ![fig. i1: Double-click this.](https://dl.dropboxusercontent.com/u/3770885/Spotifious%20Stuff/fig%20i1%20hotkey.png)
 
@@ -70,38 +67,41 @@ search for cool music.
 
 Once you've searched for something, you can continue to browse albums and arists through Spotifious. Actioning an artist will bring up a list of their albums, and actioning an album will bring up the track list.
 
+If you're looking through a really long album or a particularly prodigious artist, you can also narrow your search by typing a little more— Spotifious will search for results within the album or artist.
+
 **Note:** You can always leave a menu and go back just by pressing `⌫`.
 
 ![Album list](https://dl.dropboxusercontent.com/u/3770885/Spotifious%20Stuff/artist%20menu.png)
 ![Track list](https://dl.dropboxusercontent.com/u/3770885/Spotifious%20Stuff/album%20menu.png)
 
-## Configuration ##
+## Acknowledgements ##
 
-### Show artwork ###
+A lot of people helped out on this:
 
-1. Open Alfred preferences and select `Spotifious` under `Workflows`.
-2. Double-click the top-most icon with a Spotify icon, labeled `spot` (fig. c1).
-3. In the textarea labeled `Script:`, change `SHOWIMAGES="no"` to `SHOWIMAGES="yes"` (fig. c2).
-4. Click `Save`.
-5. Boo-yah!
+- **vdesabou** and I trade ideas a ton
+- **PHPfunk** and his PHP Alfred workflow inspired much of `OhAlfred`
+- **David Ferguson** helped with some iffy Alfred glitches
+- a slightly modified version of [Entypo](http://www.entypo.com/) icon font face for icons.
+- and many other people mentioned in the code.
 
-![fig. c1 The thingy called `spot`](https://dl.dropboxusercontent.com/u/3770885/Spotifious%20Stuff/fig%20c1%20images.png)
-
-![fig. c2 The change as entered](https://dl.dropboxusercontent.com/u/3770885/Spotifious%20Stuff/fig%20c2%20images.png)
+Thanks to everyone who helped, and thanks to everyone who uses my work!
+Oh, and thanks for reading this whole README. I hope you enjoy Spotifious!
 
 ## TODO ##
 
 - Allow `⎇`, `^`, and `⌘` to function as modifiers (Open in Spotify, other things?).
-- Prevent Last.FM redundant artist downloads.
 - Provide settings menu in-app.
 - Make main menu links go directly to menus.
 
 ## Changelog ##
 
+See `CHANGELOG.md` for more detailed information.
+
+- v0.9: Added error reporting and context-based searching; restructrued app.
 - v0.8: Added new icons; set them as default
 - v0.7: General clean-up; added artist- and album-specific menus
 - v0.6: Added Alleyoop support
 - v0.5: Added a menu system
 - v0.1: Inital search system
 
-<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/80x15.png" /></a>
+This code is MIT Licensed.

info.plist

@@ -4,6 +4,8 @@
 <dict>
 	<key>bundleid</key>
 	<string>com.citelao.spotifious</string>
+	<key>category</key>
+	<string>Productivity</string>
 	<key>connections</key>
 	<dict>
 		<key>18496AC4-EA42-444C-A906-642E38259C96</key>
@@ -18,7 +20,7 @@
 			</dict>
 			<dict>
 				<key>destinationuid</key>
-				<string>CBDD35D9-C95A-4A15-BB2C-86A429FDA6CF</string>
+				<string>C8A768AF-C5D9-47A1-B499-8B0D3C844A99</string>
 				<key>modifiers</key>
 				<integer>0</integer>
 				<key>modifiersubtext</key>
@@ -104,7 +106,12 @@ end tell
 				<key>runningsubtext</key>
 				<string>Getting Spotifious data...</string>
 				<key>script</key>
-				<string>php -f main.php -- "{query}"</string>
+				<string>php -f main.php -- "{query}"
+
+# In case you are experiencing unsolveable issues,
+# you can generate a log file to help me. Modify the
+# first line of this script so it looks like this:
+# php -f main.php -- "{query}" | tee ~/Desktop/Spotifious.log</string>
 				<key>subtext</key>
 				<string>Search for artists, tracks, or albums</string>
 				<key>title</key>
@@ -122,18 +129,32 @@ end tell
 			<integer>0</integer>
 		</dict>
 		<dict>
-			<key>config</key>
-			<dict/>
 			<key>type</key>
-			<string>alfred.workflow.action.browseinalfred</string>
+			<string>alfred.workflow.action.revealfile</string>
 			<key>uid</key>
-			<string>CBDD35D9-C95A-4A15-BB2C-86A429FDA6CF</string>
+			<string>C8A768AF-C5D9-47A1-B499-8B0D3C844A99</string>
 			<key>version</key>
 			<integer>0</integer>
 		</dict>
 	</array>
 	<key>readme</key>
-	<string></string>
+	<string># Spotifious
+# v0.9
+
+I’ve worked a long time on it to make it as good as it can be, and if you have any ideas to make it better or if you need to complain, leave me a note on my GitHub page or on the forum threads, linked below.
+
+GitHub: https://github.com/citelao/Spotify-for-Alfred/
+Forum Link: http://www.alfredforum.com/topic/1644-spotifious-a-natural-spotify-controller-for-alfred/
+
+A lot of people helped out on this:
+- vdesabou and I both trade ideas a ton (sockets were his idea)
+- PHPfunk’s PHP Alfred workflow inspired much of OhAlfred
+- and many more people are referenced in the code itself.
+Thank you everyone! Y’all made Spotifious as awesome as it is.
+
+Also thank you for using Spotifious and reading the README; I hope you enjoy it.
+
+This code is MIT Licensed.</string>
 	<key>uidata</key>
 	<dict>
 		<key>18496AC4-EA42-444C-A906-642E38259C96</key>
@@ -146,7 +167,7 @@ end tell
 			<key>ypos</key>
 			<real>10</real>
 		</dict>
-		<key>CBDD35D9-C95A-4A15-BB2C-86A429FDA6CF</key>
+		<key>C8A768AF-C5D9-47A1-B499-8B0D3C844A99</key>
 		<dict>
 			<key>ypos</key>
 			<real>130</real>

main.php

@@ -8,7 +8,7 @@
 require 'vendor/autoload.php';
 
 /**
- * Spotifious (v0.7)
+ * Spotifious (v0.9)
  * 	a natural Spotify controller for Alfred <https://github.com/citelao/Spotify-for-Alfred/>
  * 	an Alfred extension by Ben Stolovitz <http://github.com/citelao/>
  **/