Skip to content

Commit

Permalink
Update Home doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Regis Kuckaertz committed Nov 16, 2018
1 parent bb31f77 commit 7caf5c8
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 8 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Scanamo [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.11/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.12) [![Build Status](https://travis-ci.org/scanamo/scanamo.svg?branch=master)](https://travis-ci.org/scanamo/scanamo) [![Coverage Status](https://coveralls.io/repos/github/guardian/scanamo/badge.svg?branch=master)](https://coveralls.io/github/guardian/scanamo?branch=master) [![Chat on gitter](https://badges.gitter.im/guardian/scanamo.svg)](https://gitter.im/guardian/scanamo)
| CI | Coverage | Release | Issues | Users | Chat |
| --- | --- | --- | --- | --- | --- |
| [![Build Status][Badge-Travis]][Link-Travis] | [![Coverage Status][Badge-Codecov]][Link-Codecov] | [![Release Artifacts][Badge-MavenReleases]][Link-MavenReleases] | [![Average time to resolve an issue][Badge-IsItMaintained]][Link-IsItMaintained] | [![Scaladex dependencies badge][Badge-Scaladex]][Link-Scaladex] | [![Gitter][Badge-Gitter]][Link-Gitter] |
=======

Scanamo is a library to make using [DynamoDB](https://aws.amazon.com/documentation/dynamodb/) with Scala
Expand All @@ -11,9 +13,7 @@ Installation
------------

```scala
libraryDependencies ++= Seq(
"com.gu" %% "scanamo" % "1.0.0-M8"
)
libraryDependencies += "com.gu" %% "scanamo" % "1.0.0-M8"
```

Scanamo is published for Scala 2.12 and Scala 2.11
Expand Down Expand Up @@ -55,3 +55,18 @@ you may not use this software except in compliance with the License.
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.


[Link-Codecov]: https://coveralls.io/github/guardian/scanamo?branch=master "Codecov"
[Link-IsItMaintained]: https://isitmaintained.com/project/scanamo/scanamo "Average time to resolve an issue"
[Link-Scaladex]: https://index.scala-lang.org/search?q=dependencies:scanamo/scanamo "Scaladex"
[Link-MavenReleases]: https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.12 "Maven Releases"
[Link-Travis]: https://travis-ci.org/scanamo/scanamo "Travis CI"
[Link-Gitter]: https://gitter.im/guardian/scanamo "Gitter chat"

[Badge-Codecov]: https://coveralls.io/repos/github/guardian/scanamo/badge.svg?branch=master "Codecov"
[Badge-IsItMaintained]: http://isitmaintained.com/badge/resolution/scanamo/scanamo.svg "Average time to resolve an issue"
[Badge-Scaladex]: https://index.scala-lang.org/count.svg?q=dependencies:scanamo/scanamo&subject=scaladex "Scaladex"
[Badge-MavenReleases]: https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.11/badge.svg "Maven Releases"
[Badge-Travis]: https://travis-ci.org/scanamo/scanamo.svg?branch=master "Travis CI"
[Badge-Gitter]: https://badges.gitter.im/guardian/scanamo.svg "Gitter chat"
23 changes: 19 additions & 4 deletions docs/src/main/tut/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ section: home
position: 1
---

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.11/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.12) [![Build Status](https://travis-ci.org/guardian/scanamo.svg?branch=master)](https://travis-ci.org/guardian/scanamo) [![Coverage Status](https://coveralls.io/repos/github/guardian/scanamo/badge.svg?branch=master)](https://coveralls.io/github/guardian/scanamo?branch=master) [![Chat on gitter](https://badges.gitter.im/guardian/scanamo.svg)](https://gitter.im/guardian/scanamo)
| CI | Coverage | Release | Issues | Users | Chat |
| --- | --- | --- | --- | --- | --- |
| [![Build Status][Badge-Travis]][Link-Travis] | [![Coverage Status][Badge-Codecov]][Link-Codecov] | [![Release Artifacts][Badge-MavenReleases]][Link-MavenReleases] | [![Average time to resolve an issue][Badge-IsItMaintained]][Link-IsItMaintained] | [![Scaladex dependencies badge][Badge-Scaladex]][Link-Scaladex] | [![Gitter][Badge-Gitter]][Link-Gitter] |

Scanamo is a library to make using [DynamoDB](https://aws.amazon.com/documentation/dynamodb/) with Scala
simpler and less error-prone.
Expand All @@ -18,9 +20,7 @@ Quick start
Scanamo is published for Scala 2.11 and 2.12 to Maven Central, so just add the following to your `build.sbt`:

```scala
libraryDependencies ++= Seq(
"com.gu" %% "scanamo" % "1.0.0-M6"
)
libraryDependencies += "com.gu" %% "scanamo" % "1.0.0-M8"
```

then, given a table and some case classes
Expand Down Expand Up @@ -52,3 +52,18 @@ The translation between Dynamo items and Scala types is handled by a type class
called [DynamoFormat](dynamo-format.html).

Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).


[Link-Codecov]: https://coveralls.io/github/guardian/scanamo?branch=master "Codecov"
[Link-IsItMaintained]: https://isitmaintained.com/project/scanamo/scanamo "Average time to resolve an issue"
[Link-Scaladex]: https://index.scala-lang.org/search?q=dependencies:scanamo/scanamo "Scaladex"
[Link-MavenReleases]: https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.12 "Maven Releases"
[Link-Travis]: https://travis-ci.org/scanamo/scanamo "Travis CI"
[Link-Gitter]: https://gitter.im/guardian/scanamo "Gitter chat"

[Badge-Codecov]: https://coveralls.io/repos/github/guardian/scanamo/badge.svg?branch=master "Codecov"
[Badge-IsItMaintained]: http://isitmaintained.com/badge/resolution/scanamo/scanamo.svg "Average time to resolve an issue"
[Badge-Scaladex]: https://index.scala-lang.org/count.svg?q=dependencies:scanamo/scanamo&subject=scaladex "Scaladex"
[Badge-MavenReleases]: https://maven-badges.herokuapp.com/maven-central/com.gu/scanamo_2.11/badge.svg "Maven Releases"
[Badge-Travis]: https://travis-ci.org/scanamo/scanamo.svg?branch=master "Travis CI"
[Badge-Gitter]: https://badges.gitter.im/guardian/scanamo.svg "Gitter chat"

0 comments on commit 7caf5c8

Please sign in to comment.