Skip to content

Commit

Permalink
Add publishing tools for API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
travisbrown committed Jan 28, 2015
1 parent e003eeb commit ccfece5
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
[![Build status](https://img.shields.io/travis/finagle/finagle-smtp/master.svg)](http://travis-ci.org/finagle/finagle-smtp) [![Coverage status](https://img.shields.io/coveralls/finagle/finagle-smtp/master.svg)](https://coveralls.io/r/finagle/finagle-smtp?branch=master)

This is a minimum implementation of SMTP client for finagle according to
[`RFC5321`][rfc]. The simplest guide to SMTP can be found, for example, [here][smtp2go].
[`RFC5321`][rfc]. Please see the [API documentation][docs] for information
that isn't covered in the introduction below.

Note: There is no API yet in this implementation for creating
[`MIME`][mimewiki] messages, so the message should be plain US-ASCII text, or converted
to such. There is currently no support for any other SMTP extensions, either. This
functionality is to be added in future versions.

[rfc]: http://tools.ietf.org/search/rfc5321
[smtp2go]: http://www.smtp2go.com/articles/smtp-protocol
[docs]: https://finagle.github.io/finagle-smtp/docs/
[mimewiki]: http://en.wikipedia.org/wiki/MIME

## Usage
Expand Down Expand Up @@ -101,4 +102,4 @@ Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.
9 changes: 8 additions & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,14 @@ lazy val root = project.in(file("."))
"org.mockito" % "mockito-all" % "1.10.19" % "test",
"org.scalatest" %% "scalatest" % "2.2.3" % "test"
)
).settings(publishSettings: _*)
)
.settings(publishSettings: _*)
.settings(site.settings: _*)
.settings(site.includeScaladoc("docs"): _*)
.settings(ghpages.settings: _*)
.settings(
git.remoteRepo := "[email protected]:finagle/finagle-smtp.git"
)

lazy val publishSettings = Seq(
publishMavenStyle := true,
Expand Down
7 changes: 6 additions & 1 deletion project/plugins.sbt
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
resolvers += Classpaths.sbtPluginReleases
resolvers ++= Seq(
"jgit-repo" at "http://download.eclipse.org/jgit/maven",
Classpaths.sbtPluginReleases
)

addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.0.0")
addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.5.3")
addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "0.8.1")
addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.0.4")
addSbtPlugin("org.scoverage" % "sbt-coveralls" % "1.0.0.BETA1")

0 comments on commit ccfece5

Please sign in to comment.