readying for launch

.gitignore

@@ -1,3 +1,4 @@
 out
 .idea/workspace.xml
+copy-as-github-path-plugin.zip
 

META-INF/plugin.xml

@@ -2,11 +2,18 @@
   <id>com.squareup.intellij.plugin.copy-as-github-path</id>
   <name>Copy &amp; Browse as Github Path</name>
   <version>1.0</version>
-  <vendor email="support@example.com" url="http://www.squareup.com">Square, Inc</vendor>
+  <vendor email="jaw@squareup.com" url="http://www.squareup.com">Square, Inc</vendor>
 
   <description><![CDATA[
       For projects with git repos in the base, it allows you to copy the current file's path on
-      master, and open that with the default browser.
+      master, and open that with the default browser.<br>
+
+      Handy when you want to quickly navigate to a file in Intellij and then share the github link
+      (including line number) with someone else.<br>
+
+      <a href="https://github.com/jawspeak/intellij-plugin-copy-and-open-github-url">
+      Github source</a> and issue tracker.
+      <br>
       ]]></description>
 
   <change-notes><![CDATA[
@@ -30,13 +37,14 @@
   </project-components>
 
   <actions>
-    <action id="com.squareup.intellij.CopyAndOpenGithubUrlForFile" class="com.squareup.intellij.CopyAndOpenGithubUrlForFile"
+    <action id="com.squareup.intellij.CopyAndOpenGithubUrlForFile"
+        class="com.squareup.intellij.CopyAndOpenGithubUrlForFile"
         text="Copy url and open Github (master)"
         description="Copy and open the URL to this file in github, assuming the master branch">
-        <add-to-group group-id="EditorPopupMenu"/>
-        <add-to-group group-id="ProjectViewPopupMenu"/>
-        <add-to-group group-id="EditorTabPopupMenu"/>
-        <add-to-group group-id="ConsoleEditorPopupMenu"/>
+      <add-to-group group-id="EditorPopupMenu"/>
+      <add-to-group group-id="ProjectViewPopupMenu"/>
+      <add-to-group group-id="EditorTabPopupMenu"/>
+      <add-to-group group-id="ConsoleEditorPopupMenu"/>
     </action>
   </actions>
 

README.md

@@ -1,2 +1,26 @@
 ## Info
 For projects with git repos in the base, it allows you to copy the current file's path on the master branch, and open that with the default browser.
+
+Handy when you want to open a file in Intellij and then share the github link (including line number) with someone else.
+
+
+## Developing
+
+You'll need to set this up as any other plugin, see IntelliJ's tutorials.
+
+
+## Deploying for the World to Use
+
+1. right click on the plugin module and choose: "Prepare plugin module 'copy-as-github-path-plugin' for Deployment"
+2. this creates a zip, which you upload to [Jetbrains](http://plugins.jetbrains.com/plugin/addPlugin?pr=).
+
+
+## Installing locally
+
+1. Build as before, but copy the extracted zip into `~/Library/Application Support/IntelliJIdeaXX`, where XX is your current version of Intellij.
+
+
+## Bugs
+
+1. Report them on [github's issue tracker](https://github.com/jawspeak/intellij-plugin-copy-and-open-github-url/issues).
+