Commits

David Carr  committed 38e66dc

docs: note the need to configure a snapshot repository

  • Participants
  • Parent commits 40181d4

Comments (0)

Files changed (1)

File src/docs/guide/gettingStarted.gdoc

-h4. First, install the plugin by adding a dependency in @BuildConfig.groovy@ (replace VERSION with the desired version):
+h4. Installation
+
+Install the plugin by adding the following to your @BuildConfig.groovy@ (replace @VERSION@ with the desired version):
 
 {code}
+repositories {
+    ...
+    mavenRepo 'https://oss.sonatype.org/content/repositories/snapshots'
+}
 plugins {
-   ...
-   runtime ':mongeez:VERSION'
+    ...
+    runtime ':mongeez:VERSION'
 }
 {code}
 
+{note}
+The repository is currently needed because the plugin currently depends on a snapshot version of [Mongeez|https://github.com/secondmarket/mongeez].  It is expected that the need to configure a snapshot repository will be eliminated in a future release.
+{note}
+
 h4. Changelog Creation
 
 Next, you'll need to create some changelogs.  Currently two formats are supported; JavaScript or XML.  The Javascript