Merge pull request #533 from JordanMartinez/jitpackToReadme

Jitpack to readme

Author: JordanMartinez

README.md

@@ -3,7 +3,7 @@ RichTextFX
 
 RichTextFX provides a memory-efficient text area for JavaFX that allows the developer to style ranges of text, display custom objects in-line (no more HTMLEditor), and override the default behavior only where necessary without overriding any other part of the behavior.
 
-It does not follow the MVC paradigm as this prevented access to view-specific API (e.g., getting the bounds of the caret/selection/characters, scrolling by some amount, .
+It does not follow the MVC paradigm as this prevented access to view-specific API (e.g., getting the bounds of the caret/selection/characters, scrolling by some amount, etc.).
 
 It is intended as a base for rich-text editors and code editors with syntax highlighting. Since it is a base, a number of suggested features (specific syntax highlighters, search-and-replace, specific support for hyperlinks, etc.) will not be implemented directly in this project. Rather, developers can implement these on top of RichTextFX and submit their work as a PR to the `richtextfx-demos` package.
 
@@ -27,6 +27,7 @@ For a greater explanation of RichTextFX, its design principles, how it works, an
   * [Stable](#stable-release)
   * [Milestone](#milestone-release)
   * [Snapshot](#snapshot-releases)
+  * [Custom via Jitpack](#custom-via-jitpack)
 * API Documentation (Javadoc)
   - [0.6.10](http://fxmisc.github.io/richtext/javadoc/0.6.10/org/fxmisc/richtext/package-summary.html)
   - [0.7-M5](http://fxmisc.github.io/richtext/javadoc/0.7-M5/org/fxmisc/richtext/package-summary.html)
@@ -37,15 +38,15 @@ For a greater explanation of RichTextFX, its design principles, how it works, an
 Who uses RichTextFX?
 --------------------
 
-[Kappa IDE](https://bitbucket.org/TomasMikula/kappaide/)  
-[Squirrel SQL client](http://www.squirrelsql.org/) (its JavaFX version)  
-[mqtt-spy](http://kamilfb.github.io/mqtt-spy/)  
-[Alt.Text](http://alttexting.com/)  
-[Xanthic](https://github.com/jrguenther/Xanthic)  
-[Arduino Harp](https://www.youtube.com/watch?v=rv5raLcsPNs)  
-[Markdown Writer FX](https://github.com/JFormDesigner/markdown-writer-fx)  
-[OmniEditor](https://github.com/giancosta86/OmniEditor), which is then used by [Chronos IDE](https://github.com/giancosta86/Chronos-IDE)  
-[JuliarFuture](https://juliar.org)  
+[Kappa IDE](https://bitbucket.org/TomasMikula/kappaide/)
+[Squirrel SQL client](http://www.squirrelsql.org/) (its JavaFX version)
+[mqtt-spy](http://kamilfb.github.io/mqtt-spy/)
+[Alt.Text](http://alttexting.com/)
+[Xanthic](https://github.com/jrguenther/Xanthic)
+[Arduino Harp](https://www.youtube.com/watch?v=rv5raLcsPNs)
+[Markdown Writer FX](https://github.com/JFormDesigner/markdown-writer-fx)
+[OmniEditor](https://github.com/giancosta86/OmniEditor), which is then used by [Chronos IDE](https://github.com/giancosta86/Chronos-IDE)
+[JuliarFuture](https://juliar.org)
 
 If you use RichTextFX in an interesting project, I would like to know!
 
@@ -296,7 +297,7 @@ Snapshot releases are deployed to Sonatype snapshot repository.
 ```groovy
 repositories {
     maven {
-        url 'https://oss.sonatype.org/content/repositories/snapshots/' 
+        url 'https://oss.sonatype.org/content/repositories/snapshots/'
     }
 }
 
@@ -313,6 +314,51 @@ resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repos
 libraryDependencies += "org.fxmisc.richtext" % "richtextfx" % "1.0.0-SNAPSHOT"
 ```
 
+### Custom Via Jitpack
+
+In the following examples, the version is either a commit (via its short hash) or a tag.
+
+#### Maven
+
+Add the repository
+````xml
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+````
+
+Add the dependency
+````xml
+<dependency>
+    <groupId>com.github.TomasMikula</groupId>
+    <artifactId>RichTextFX</artifactId>
+    <version>commitOrTag</version>
+</dependency>
+````
+
+#### Gradle example
+````groovy
+repositories {
+    maven {
+        url 'https://jitpack.io'
+    }
+}
+
+dependencies {
+    compile "com.github.TomasMikula:RichTextFX:commitOrTag"
+}
+````
+
+#### Sbt example
+
+```scala
+resolvers += "jitpack" at "https://jitpack.io"
+
+libraryDependencies += "com.github.TomasMikula" % "RichTextFX" % "commitOrTag"
+```
 
 License
 -------