Skip to content

Commit 9081e9c

Browse files
committed
little readme updates/additions
1 parent 027ef19 commit 9081e9c

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# Scala modules sbt plugin
22

3-
This is an sbt plugin for creating a scala module build.
3+
This is an sbt plugin for building Scala modules (scala-xml,
4+
scala-parser-combinators, and so on).
5+
6+
The major benefit of the plugin is to provide automated tag-based
7+
publishing via Sonatype. Releasing only requires pushing a tag
8+
to GitHub, then Travis does the rest.
49

510
## Usage
611

712
Add the plugin to the `project/plugins.sbt` file:
813

914
```
10-
addSbtPlugin("org.scala-lang.modules" % "scala-module-plugin" % "1.0.6")
15+
addSbtPlugin("org.scala-lang.modules" % "scala-module-plugin" % "1.0.8")
1116
```
1217

1318
Then, in your `build.sbt` add:
@@ -59,6 +64,12 @@ The following settings are also available:
5964

6065
## Cutting a new release (of this plugin)
6166

67+
### Release notes
68+
69+
Tag the release and add release notes to https://github.com/scala/sbt-scala-modules/releases
70+
71+
### Publishing via Bintray
72+
6273
- Sign in to Bintray (https://bintray.com/login) or create an "Open Source" account (https://bintray.com/signup/oss)
6374
- Check if you have a repository named `sbt-plugins`. If not, create it (Name: sbt-plugins, Type: Generic).
6475
- Make sure the current `HEAD` is a tagged revision. In sbt, `version` (set by sbt-git) should be according to a tag.

0 commit comments

Comments
 (0)