David Warburton avatar David Warburton committed dae20d4

README converted to markdown and improved.

Comments (0)

Files changed (2)

README

-This is a plugin for sublime text 2 that will push and pull theme assets from Shopify.
-
-Installation:
-1) cd <shopify package directory>
-2) hg clone https://bitbucket.org/dwarburton/sublimeshopify Shopify
-
-Usage:
-There are several commands that can be accessed from Sublime Text's command pallete to
-interact with Shopify.  The first invocation of any of these will instead open the file
-where your Shopify access credentials must be configured.  Follow the instructions at
-http://wiki.shopify.com/Shopify_Textmate_Bundle to find the values for these settings,
-with one exception: the Shop Name should only be the first subdomain of the shopify
-address (.myshopify.com is added automatically).
-
-When the configuration file is saved, then you may immediately use the Shopify commands.
-Launching any one of the commands will chain together all of the commands necessary to
-get to the correct asset you would like to edit.  For example, if you run the Show Assets
-command but haven't selected a store or theme, then you will be prompted for those first.
-The second time you run the Show Assets command, you will not need to choose the store or
-theme.  If you want an asset from a different theme or different store, then run the command
-to Show Stores or Show Themes to switch.
-
-The downloaded files are uploaded automatically when they are saved.  You will see a
-confirmation or failure message in the status bar after saving.
-
-Currently there is very little cleverness in the downloading and saving of assets.
-You *will* be able to clobber more recent changes made by someone else and the asset
-*will* be downloaded everytime it is opened, even if it has not been changed.
+Sublime Shopify
+===============
+
+
+This is a plugin for Sublime Text 2 that will push and pull theme assets from Shopify.
+
+Installation
+------------
+1. `cd <shopify package directory>`
+2. `hg clone https://bitbucket.org/dwarburton/sublimeshopify Shopify`
+
+Usage
+-----
+There are several commands that can be accessed from Sublime Text's command pallete to
+interact with Shopify.  The first invocation of any of these will instead open the file
+where your Shopify access credentials must be configured.  Follow the instructions at
+http://wiki.shopify.com/Shopify_Textmate_Bundle to find the values for these settings,
+with one exception: the Shop Name should only be the first subdomain of the shopify
+address (.myshopify.com is added automatically).
+
+When the configuration file is saved, then you may immediately use the Shopify commands.
+Launching any one of the commands will chain together all of the commands necessary to
+get to the correct asset you would like to edit.  For example, if you run the Show Assets
+command but haven't selected a store or theme, then you will be prompted for those first.
+The second time you run the Show Assets command, you will not need to choose the store or
+theme.  If you want an asset from a different theme or different store, then run the command
+to Show Stores or Show Themes to switch.
+
+The downloaded files are uploaded automatically when they are saved.  You will see a
+confirmation or failure message in the status bar after saving.
+
+Warnings
+--------
+
+Currently there is very little cleverness in the downloading and saving of assets.
+You *will* be able to clobber more recent changes made by someone else and the asset
+*will* be downloaded everytime it is opened, even if it has not been changed.
+
+<span style="color: red">The security protecting your API key is not very strong.</span>  On Windows and OS X
+the API key will be transmitted by HTTPS, but the python library used (urllib) does
+not validate certificates and so the API key could be stolen by a man in the middle
+attack.  On Linux HTTPS cannot be used because the python distributed with Sublime
+Text 2 Linux Edition was not compiled with SSL and so the API key is available
+to man in the middle attackers and also attackers on the local network.  On all systems
+the API key will be available to attackers who have administrative access to your PC.  **These
+are also limitations of the official Shopify TextMate bundle (except the linux/https issue).**
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.