Skip to content

Commit

Permalink
Document for SBT 0.13 only
Browse files Browse the repository at this point in the history
  • Loading branch information
rtimush committed Nov 23, 2014
1 parent 725ed22 commit a2179b4
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ Display your SBT project's dependency updates.

Requirements
==============
SBT 0.12, 0.13.x
SBT 0.13.x

Note: use version 0.1.0 for SBT 0.11.* series
Note: use version 0.1.0 for SBT 0.11.x, version 0.1.6 for SBT 0.12.x.

Installation
============
### Stable version
Add the following line to one of these files:
- The project-specific file at `project/sbt-updates.sbt`
- Your global file (for sbt version 0.13._x_) at `~/.sbt/0.13/plugins/sbt-updates.sbt`
- Your global file (for sbt versions earlier than 0.13) at `~/.sbt/plugins/sbt-updates.sbt`
- Your global file (for sbt version 0.13.x) at `~/.sbt/0.13/plugins/sbt-updates.sbt`

```
addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.1.6")
Expand All @@ -23,8 +22,7 @@ addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.1.6")
### Snapshot version
Add the following lines to one of these files:
- The project-specific file at `project/sbt-updates.sbt`
- Your global file (for sbt version 0.13._x_) at `~/.sbt/0.13/plugins/sbt-updates.sbt`
- Your global file (for sbt versions earlier than 0.13) at `~/.sbt/plugins/sbt-updates.sbt`
- Your global file (for sbt version 0.13.x) at `~/.sbt/0.13/plugins/sbt-updates.sbt`

```
resolvers += Resolver.url("sbt-plugin-snapshots", url("http://scalasbt.artifactoryonline.com/scalasbt/sbt-plugin-snapshots"))(Resolver.ivyStylePatterns)
Expand All @@ -34,18 +32,16 @@ addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.1.7-SNAPSHOT")

Tasks
=====
* `dependency-updates`: show a list of project dependencies that can be updated,
* `dependency-updates-report`: writes a list of project dependencies to a file.

Note: for SBT 0.13.x use camelCase task names `dependencyUpdates` and `dependencyUpdatesReport`.
* `dependencyUpdates`: show a list of project dependencies that can be updated,
* `dependencyUpdatesReport`: writes a list of project dependencies to a file.

Settings
========
* `dependency-updates-report-file`: report file location, `target/dependency-updates.txt` by default.
* `dependencyUpdatesReportFile`: report file location, `target/dependency-updates.txt` by default.

Example:
```
> dependency-updates
> dependencyUpdates
[info] Found 3 dependency updates for test-project
[info] ch.qos.logback:logback-classic : 0.8 -> 0.8.1 -> 0.9.30 -> 1.0.13
[info] org.scala-lang:scala-library : 2.9.1 -> 2.9.3 -> 2.10.3
Expand Down

0 comments on commit a2179b4

Please sign in to comment.