From c900311ae9bdb30087c0f5dc731310da91e900b3 Mon Sep 17 00:00:00 2001 From: Alexandre Archambault Date: Wed, 27 Jan 2016 17:42:17 +0100 Subject: [PATCH] Update README --- README.md | 18 +++++++++--------- doc/README.md | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 3dcfe08fa..a41caa157 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [ Enable the SBT plugin by adding ```scala -addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M4") +addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M5") ``` to `~/.sbt/0.13/plugins/build.sbt` (enables it globally), or to the `project/plugins.sbt` file of a SBT project. Tested with SBT 0.13.8 / 0.13.9. @@ -97,8 +97,8 @@ Fetching artifacts Add to your `build.sbt` ```scala libraryDependencies ++= Seq( - "com.github.alexarchambault" %% "coursier" % "1.0.0-M4", - "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M4" + "com.github.alexarchambault" %% "coursier" % "1.0.0-M5", + "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M5" ) ``` @@ -195,7 +195,7 @@ of the cache used by a particular project, in case you have any doubt about what Enable the SBT plugin globally by adding ```scala -addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M4") +addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M5") ``` to `~/.sbt/0.13/plugins/build.sbt` @@ -331,7 +331,7 @@ The `bootstrap` generates tiny bootstrap launchers, able to pull their dependenc repositories on first launch. For example, the launcher of coursier is [generated](https://github.com/alexarchambault/coursier/blob/master/project/generate-launcher.sh) with a command like ``` $ ./coursier bootstrap \ - com.github.alexarchambault:coursier-cli_2.11:1.0.0-M4 \ + com.github.alexarchambault:coursier-cli_2.11:1.0.0-M5 \ -b -f -o coursier \ -M coursier.cli.Coursier ``` @@ -343,12 +343,12 @@ See `./coursier bootstrap --help` for a list of the available options. Add to your `build.sbt` ```scala libraryDependencies ++= Seq( - "com.github.alexarchambault" %% "coursier" % "1.0.0-M4", - "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M4" + "com.github.alexarchambault" %% "coursier" % "1.0.0-M5", + "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M5" ) ``` -The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M4"`, mainly depends on +The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M5"`, mainly depends on `scalaz-core` (and only it, *not* `scalaz-concurrent` for example). It contains among others, definitions, mainly in [`Definitions.scala`](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala), @@ -358,7 +358,7 @@ that expects to be given metadata, wrapped in any `Monad`, then feeds these to ` you the final `Resolution`, wrapped in the same `Monad` it was given input. This final `Resolution` has all the dependencies, including the transitive ones. -The second module, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M4"`, is precisely in charge of fetching +The second module, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M5"`, is precisely in charge of fetching these input metadata. It uses `scalaz.concurrent.Task` as a `Monad` to wrap them. It also fetches artifacts (JARs, etc.). It caches all of these (metadata and artifacts) on disk, and validates checksums too. diff --git a/doc/README.md b/doc/README.md index 3bf50d3fc..144af6f4f 100644 --- a/doc/README.md +++ b/doc/README.md @@ -60,7 +60,7 @@ Lastly, it can be used programmatically via its [API](#api) and has a Scala JS [ Enable the SBT plugin by adding ```scala -addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M4") +addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M5") ``` to `~/.sbt/0.13/plugins/build.sbt` (enables it globally), or to the `project/plugins.sbt` file of a SBT project. Tested with SBT 0.13.8 / 0.13.9. @@ -97,8 +97,8 @@ Fetching artifacts Add to your `build.sbt` ```scala libraryDependencies ++= Seq( - "com.github.alexarchambault" %% "coursier" % "1.0.0-M4", - "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M4" + "com.github.alexarchambault" %% "coursier" % "1.0.0-M5", + "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M5" ) ``` @@ -195,7 +195,7 @@ of the cache used by a particular project, in case you have any doubt about what Enable the SBT plugin globally by adding ```scala -addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M4") +addSbtPlugin("com.github.alexarchambault" % "coursier-sbt-plugin" % "1.0.0-M5") ``` to `~/.sbt/0.13/plugins/build.sbt` @@ -333,7 +333,7 @@ The `bootstrap` generates tiny bootstrap launchers, able to pull their dependenc repositories on first launch. For example, the launcher of coursier is [generated](https://github.com/alexarchambault/coursier/blob/master/project/generate-launcher.sh) with a command like ``` $ ./coursier bootstrap \ - com.github.alexarchambault:coursier-cli_2.11:1.0.0-M4 \ + com.github.alexarchambault:coursier-cli_2.11:1.0.0-M5 \ -b -f -o coursier \ -M coursier.cli.Coursier ``` @@ -345,12 +345,12 @@ See `./coursier bootstrap --help` for a list of the available options. Add to your `build.sbt` ```scala libraryDependencies ++= Seq( - "com.github.alexarchambault" %% "coursier" % "1.0.0-M4", - "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M4" + "com.github.alexarchambault" %% "coursier" % "1.0.0-M5", + "com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M5" ) ``` -The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M4"`, mainly depends on +The first module, `"com.github.alexarchambault" %% "coursier" % "1.0.0-M5"`, mainly depends on `scalaz-core` (and only it, *not* `scalaz-concurrent` for example). It contains among others, definitions, mainly in [`Definitions.scala`](https://github.com/alexarchambault/coursier/blob/master/core/shared/src/main/scala/coursier/core/Definitions.scala), @@ -360,7 +360,7 @@ that expects to be given metadata, wrapped in any `Monad`, then feeds these to ` you the final `Resolution`, wrapped in the same `Monad` it was given input. This final `Resolution` has all the dependencies, including the transitive ones. -The second module, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M4"`, is precisely in charge of fetching +The second module, `"com.github.alexarchambault" %% "coursier-cache" % "1.0.0-M5"`, is precisely in charge of fetching these input metadata. It uses `scalaz.concurrent.Task` as a `Monad` to wrap them. It also fetches artifacts (JARs, etc.). It caches all of these (metadata and artifacts) on disk, and validates checksums too.