Merge pull request #17 from MarkEWaite/migrate-docs-to-github

Migrate documentation to GitHub

README.md

@@ -0,0 +1,25 @@
+# Clone workspace SCM plugin
+
+Archive the workspace from builds of one job and reuse them as the SCM source for another job.
+
+## Usage
+
+The plugin provides a "publisher" that freestyle job can use to clone the workspace of one job for use by another job.
+
+-   In the configuration for a project whose workspace you want to clone and re-use in other projects, select "Archive for Clone Workspace SCM" in the list of publishers
+-   If desired, specify the files to include in the archive - by default, this will be "\***/**". Use Ant-style globs
+-   Specify the criteria a build needs to meet in order to be archived
+-   Run a build.
+    If it meets the criteria, its workspace will be archived, until a new build meeting the criteria has run, at which point the old archive will be deleted
+
+## SCM
+
+-   In the configuration for a project which you wish to have re-use another project's workspace, select "Clone Workspace" from the list of possible SCMs
+-   Choose the parent project whose workspace you wish to re-use from the drop-down list - if no projects have the clone workspace publisher enabled, the drop-down will be empty
+-   Choose the parent build criteria you wish to use
+-   Run a build - assuming the parent project has an archived workspace meeting the criteria in question, it'll be expanded and used as the workspace for this build
+-   Additionally, the changelog from the parent project build that archived workspace came from will be re-used as the changelog for this build
+
+## Version history
+
+See [GitHub releases](https://github.com/jenkinsci/jenkins-clone-workspace-scm-plugin/releases) for recent releases.

pom.xml

@@ -34,8 +34,7 @@ THE SOFTWARE.
   <packaging>hpi</packaging>
   <name>Jenkins Clone Workspace SCM Plug-in</name>
   <version>0.7-SNAPSHOT</version>
-  <url>http://wiki.jenkins-ci.org/display/JENKINS/Clone+Workspace+SCM+Plugin</url>
-  <description>Plugin to archive workspaces from one project and reuse those as SCM sources for other projects.</description>
+  <url>https://github.com/jenkinsci/jenkins-clone-workspace-scm-plugin</url>
 
   <licenses>
     <license>
@@ -93,4 +92,4 @@ THE SOFTWARE.
     <url>http://github.com/jenkinsci/jenkins-clone-workspace-scm-plugin</url>
   </scm>
 
-</project>
+</project>