Commits

David Carr committed 40a6921

readme: update readme now that the plugin's in jcenter

  • Participants
  • Parent commits de49a2d

Comments (0)

Files changed (1)

 # Overview
-The Site plugin is a [Gradle][] plugin for publishing static HTML websites.  It is available for use under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).  If you have any issues, please check the [issue tracker](https://bitbucket.org/davidmc24/gradle-site-plugin/issues?status=new&status=open), and if there isn't anything relevant, submit a new issue.
+The Site plugin is a [Gradle](http://www.gradle.org/) plugin for publishing static HTML websites.  It is available for use under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).  If you have any issues, please check the [issue tracker](https://bitbucket.org/davidmc24/gradle-site-plugin/issues?status=new&status=open), and if there isn't anything relevant, submit a new issue.
 
 # Distribution
-The plugin is distributed via [Bintray][].  Currently, to access it, you need to have a [Bintray] user account.
+The plugin is distributed via [Bintray](https://www.bintray.com/).  If desired, you can use the [Bintray plugin](https://bitbucket.org/davidmc24/gradle-bintray-plugin) to simplify the configuration of Bintray repositories within Gradle build scripts.
 
 # Usage
-To use the plugin, configure your build.gradle and gradle.properties based on the examples below.
-
-## build.gradle
+To use the plugin, configure your `build.gradle` based the example below.
 
     :::groovy
     buildscript {
         repositories {
-            maven { url = 'http://jcenter.bintray.com' }
             maven {
-                url = 'http://dl.bintray.com/content/davidmc24/gradle-plugins'
-                try {
-                    credentials {
-                        username = bintrayUserName
-                        password = bintrayApiKey
-                    }
-                } catch (MissingPropertyException pne) {
-                    // ignore, don't authenticate
-                }
+            	name = 'BintrayJCenter'
+            	url = 'http://jcenter.bintray.com'
             }
         }
         dependencies {
     }
     apply plugin: 'site'
 
-## gradle.properties
-
-    bintrayUserName = YOUR_USER
-    bintrayApiKey = YOUR_API_KEY
-
 # Source sets
 
 The Site plugin adds a `site` source set.  This source set works in the same manner as with other plugins, though our interest is primarily in the resources.
 
 # ProcessSiteResources
 
-The Site plugin uses the [Copy][] task for resource handling.  See the [Gradle User Guide][] for more information.
+The Site plugin uses the [Copy](http://www.gradle.org/docs/current/dsl/org.gradle.api.tasks.Copy.html) task for resource handling.  See the [Gradle User Guide](http://www.gradle.org/docs/current/userguide/userguide.html) for more information.
 
 Task Property    | Type     | Default Value
 ---------------- | -------- | -----------------------------------
 
 # PublishSite
 
-The Site plugin uses [Maven Wagon][] to provide site publishing capability over a number of different protocols.  Currently, only the SFTP provider has been tested, though others (HTTP, FTP, SCP, WebDAV, file) may work as well.
+The Site plugin uses [Maven Wagon](https://maven.apache.org/wagon/) to provide site publishing capability over a number of different protocols.  Currently, only the SFTP provider has been tested, though others (HTTP, FTP, SCP, WebDAV, file) may work as well.
 
 Task Property        | Type                 | Default Value
 -------------------- | -------------------- | -----------------------------------
 `baseDir`            | `File`               | `site.sourceSet.output.resourceDir`
 `url`                | `String`             | `site.url`
 `authenticationInfo` | `AuthenticationInfo` | `site.authenticationInfo`
-
-[gradle]: http://www.gradle.org/
-[bintray]: https://www.bintray.com/
-[copy]: http://www.gradle.org/docs/current/dsl/org.gradle.api.tasks.Copy.html
-[gradle user guide]: http://www.gradle.org/docs/current/userguide/userguide.html
-[maven wagon]: https://maven.apache.org/wagon/