Release v0.5.0

scalameta · Oct 1, 2018 · d5efa64 · d5efa64
1 parent 4ff8780
commit d5efa64
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/mdoc/src/main/scala/mdoc/internal/cli/Settings.scala b/mdoc/src/main/scala/mdoc/internal/cli/Settings.scala
@@ -162,7 +162,7 @@ object Settings extends MetaconfigScalametaImplicits {
       .andThen(_.as[Settings](decoder(base)))
   }
   def version(displayVersion: String) =
-    s"Mdoc v$displayVersion"
+    s"mdoc v$displayVersion"
   def usage: String =
     """|Usage:   mdoc [<option> ...]
        |Example: mdoc --in <path> --out <path> (customize input/output directories)
@@ -173,7 +173,7 @@ object Settings extends MetaconfigScalametaImplicits {
        |""".stripMargin
   def description: Doc =
     Doc.paragraph(
-      """|Mdoc is a documentation tool that interprets Scala code examples within markdown
+      """|mdoc is a documentation tool that interprets Scala code examples within markdown
          |code fences allowing you to compile and test documentation as part your build.
          |""".stripMargin
     )

diff --git a/readme.md b/readme.md
@@ -103,7 +103,7 @@ Add the following dependency to your build
 
 ```scala
 // build.sbt
-libraryDependencies += "com.geirsson" % "mdoc" % "0.4.5" cross CrossVersion.full
+libraryDependencies += "com.geirsson" % "mdoc" % "0.5.0" cross CrossVersion.full
 ```
 
 Then write a main function that invokes mdoc as a library
@@ -126,7 +126,7 @@ object Main {
 Consult [--help](#--help) to see what arguments are valid for `withArgs`.
 
 Consult the mdoc source to learn more how to use the library API. Scaladocs are
-available [here](https://www.javadoc.io/doc/com.geirsson/mdoc_2.12.6/0.4.5)
+available [here](https://www.javadoc.io/doc/com.geirsson/mdoc_2.12.6/0.5.0)
 but beware there are limited docstrings for classes and methods. Keep in mind
 that code in the package `mdoc.internal` is subject to binary and source
 breaking changes between any release, including PATCH versions.
@@ -140,7 +140,7 @@ Then run the following command:
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.geirsson/mdoc_2.12.6/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.geirsson/mdoc_2.12.6)
 
 ```
-$ coursier launch com.geirsson:mdoc_2.12.6:0.4.5 -- --site.MY_VERSION 1.0.0
+$ coursier launch com.geirsson:mdoc_2.12.6:0.5.0 -- --site.MY_VERSION 1.0.0
 info: Compiling docs/readme.md
 info:   done => out/readme.md (120 ms)
 ```
@@ -560,7 +560,7 @@ List(User("John"), User("Susan")).sorted
 
 ### Variable injection
 
-mdoc renders constants like `0.4.5` in markdown with variables provided at
+mdoc renders constants like `0.5.0` in markdown with variables provided at
 runtime. This makes it easy to keep documentation up-to-date as new releases are
 published. Variables can be passed from the command-line interface with the
 syntax
@@ -691,15 +691,15 @@ Contributions are welcome!
 ## --help
 
 ```
-Mdoc v0.4.5
+mdoc v0.5.0
 Usage:   mdoc [<option> ...]
 Example: mdoc --in <path> --out <path> (customize input/output directories)
          mdoc --watch                  (watch for file changes)
          mdoc --site.VERSION 1.0.0     (pass in site variables)
          mdoc --include **/example.md  (process only files named example.md)
          mdoc --exclude node_modules   (don't process node_modules directory)
 
-Mdoc is a documentation tool that interprets Scala code examples within markdown
+mdoc is a documentation tool that interprets Scala code examples within markdown
 code fences allowing you to compile and test documentation as part your build. 
 
 Common options:

diff --git a/tests/unit/src/test/scala/tests/cli/CliSuite.scala b/tests/unit/src/test/scala/tests/cli/CliSuite.scala
@@ -149,7 +149,7 @@ class CliSuite extends BaseCliSuite {
     "",
     extraArgs = Array("--help"),
     onStdout = { out =>
-      assert(out.contains("Mdoc is a documentation tool"))
+      assert(out.contains("mdoc is a documentation tool"))
     }
   )