Stefan Saasen avatar Stefan Saasen committed deac68f

Update README. Add screens and deployment instructions.

Comments (0)

Files changed (1)

 * Confluence Macro
 * XWork Action
 
-![Example XWork Action](http://ssaasen.bitbucket.org/atlassian-scala-example-plugin/images/xwork-module-example.png)
+![Example macro](http://ssaasen.bitbucket.org/atlassian-scala-example-plugin/images/scala-plugin-1.png)
+![Example macro](http://ssaasen.bitbucket.org/atlassian-scala-example-plugin/images/scala-plugin-3.png)
+
 
 In addition to implementation examples this project is set up to properly build
 and compile the Scala classes, run Scala based tests and shows different ways
 
 To create the plugin with the required Scala library class files embedded.
 
+Deployment options
+------------------
 
-Resources
-=========
-
-https://www.hipchat.com/docs/api
-
+The three different deployment options are demonstrated in this plugin by using
+different profiles:
 
-http://localhost:1990/confluence/plugins/chat/rooms.action
-http://localhost:1990/confluence/plugins/servlet/hipchat
+<table>
+<tr>
+<td>Include the full <tt>scala-library</tt> dependency in the plugin</td>
+<td><code>mvn package -Pbundle</code></td>
+</tr>
+<tr>
+<td>Include a shrinked <tt>scala-library</tt> dependency in the plugin</td>
+<td><code>mvn package -Pproduction</code></td>
+</tr>
+<tr>
+<td>Depend on the <tt>scala-library</tt> being deployed as a separate plugin
+(e.g. using the (Scala provider plugin)[https://plugins.atlassian.com/plugins/com.atlassian.confluence.plugins.scala-2.9-provider-plugin]</td>
+<td><code>mvn package (-Pdefault)</code></td>
+</tr>
+</table>
 
-http://www.codecommit.com/blog/java/interop-between-java-and-scala
 
-https://developer.atlassian.com/display/DOCS/Automatic+Plugin+Reinstallation+with+FastDev
 
+Resources
+=========
 
-https://developer.atlassian.com/display/CONFDEV/Servlet+Module
+* https://www.hipchat.com/docs/api
+* https://plugins.atlassian.com/plugins/com.atlassian.confluence.plugins.scala-2.9-provider-plugin
+* http://proguard.sourceforge.net/
 
-https://developer.atlassian.com/display/CONFDEV/Disable+Velocity+Caching
-https://developer.atlassian.com/display/CONFDEV/Confluence+Objects+Accessible+From+Velocity
-https://developer.atlassian.com/display/CONFDEV/Ensuring+Standard+Page+Decoration+in+your+Plugin+UI
 
-https://developer.atlassian.com/display/CONFDEV/Including+Javascript+and+CSS+resources
-https://developer.atlassian.com/display/ATR/Using+the+Atlassian+Template+Renderer
-https://developer.atlassian.com/display/AUI/Adding+AUI+to+your+application
-https://developer.atlassian.com/display/AUI/AJS.contextPath
 
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.