Skip to content
Browse files

added screenshots to the README

  • Loading branch information...
1 parent 28def07 commit fb3a46e692ba5289423f8c23960890df0b7c3fe7 @michaelficarra committed Mar 26, 2011
View
24 README.md
@@ -1,11 +1,28 @@
+Transmission Torrent Downloader
+===============================
+
+
## Usage
On any supported page (which currently includes the Torrentz individual torrent
pages and any page containing a magnet link), a [chrome page
action](http://code.google.com/chrome/extensions/pageAction.html) will be made
available to aid in the torrent starting process.
-This extension requires the Transmission HTTP RPC. This can be enabled [through
+![chrome page action](https://github.com/michaelficarra/transmissionDownload/raw/master/images/screenshots/pageAction.png)
+
+When clicked, a chrome "popup" will be displayed. The target server will be
+displayed at the top. Press the button to initiate the torrent-adding process.
+
+![initiate torrent download](https://github.com/michaelficarra/transmissionDownload/raw/master/images/screenshots/addTorrent.png)
+
+You will see a stream of status messages followed by either a green success
+message or a red error message. In the event that a green success message was
+output, the torrent should now be added to the transmission server.
+
+![successful output](https://github.com/michaelficarra/transmissionDownload/raw/master/images/screenshots/output.png)
+
+*Note:* This extension requires the Transmission HTTP RPC. This can be enabled [through
the preferences
GUI](http://www.transmissionbt.com/help/gtk/2.2x/html/preferences.html#web)
when using transmission-gtk or by setting the `rpc-enabled` and related `rpc-*`
@@ -17,8 +34,13 @@ values in transmission-daemon's `settings.json` file when using transmission-dae
* Adds torrents to a transmission server (remote or local)
* (optionally) Adds all trackers from tracker aggregation websites
* Saves and optionally encrypts login information
+
+ ![encryption prompt](https://github.com/michaelficarra/transmissionDownload/raw/master/images/screenshots/encryption.png)
+
* Adds additional, specified trackers to each torrent
+![options page](https://github.com/michaelficarra/transmissionDownload/raw/master/images/screenshots/options.png)
+
## Installation
View
BIN images/screenshots/addTorrent.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN images/screenshots/encryption.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN images/screenshots/options.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN images/screenshots/output.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
BIN images/screenshots/pageAction.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fb3a46e

Please sign in to comment.
Something went wrong with that request. Please try again.