Skip to content

Commit

Permalink
Merge branch 'master' into update/upickle-4.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
adamw authored Dec 18, 2024
2 parents 282a5b4 + ea9e20a commit e0c83f5
Show file tree
Hide file tree
Showing 146 changed files with 1,896 additions and 4,303 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,15 +48,15 @@ sttp (v2) documentation is available at [sttp.softwaremill.com/en/v2](https://st

sttp (v1) documentation is available at [sttp.softwaremill.com/en/v1](https://sttp.softwaremill.com/en/v1).

scaladoc is available at [https://www.javadoc.io](https://www.javadoc.io/doc/com.softwaremill.sttp.client4/core_2.12/4.0.0-M18)
scaladoc is available at [https://www.javadoc.io](https://www.javadoc.io/doc/com.softwaremill.sttp.client4/core_2.12/4.0.0-M20)

## Quickstart with scala-cli

Add the following directive to the top of your scala file to add the core sttp dependency:
If you are using [scala-cli](https://scala-cli.virtuslab.org), you can quickly start experimenting with sttp by copy-pasting the following:

```
//> using dep "com.softwaremill.sttp.client4::core:4.0.0-M18"
//> using dep "com.softwaremill.sttp.client4::core:4.0.0-M20"
import sttp.client4.quick._
quickRequest.get(uri"http://httpbin.org/ip").send()
```
Expand All @@ -68,7 +68,7 @@ The `quick` package import brings in the sttp API and a pre-configured, global s
Similarly, using [Ammonite](http://ammonite.io):

```scala
import $ivy.`com.softwaremill.sttp.client4::core:4.0.0-M18`
import $ivy.`com.softwaremill.sttp.client4::core:4.0.0-M20`
import sttp.client4.quick._
quickRequest.get(uri"http://httpbin.org/ip").send()
```
Expand All @@ -78,7 +78,7 @@ quickRequest.get(uri"http://httpbin.org/ip").send()
Add the following dependency:

```scala
"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M18"
"com.softwaremill.sttp.client4" %% "core" % "4.0.0-M20"
```

Then, import:
Expand Down Expand Up @@ -110,6 +110,8 @@ We are also always looking for contributions and new ideas, so if you’d like t
Note that running the default `test` task will run the tests using both the JVM and JS backends, and is likely to run out of memory.
If you'd like to run the tests using *only* the JVM backend, execute: `sbt rootJVM/test`.

When you have a PR ready, take a look at our ["How to prepare a good PR" guide](https://softwaremill.community/t/how-to-prepare-a-good-pr-to-a-library/448). Thanks! :)

### Importing into IntelliJ

By default, when importing to IntelliJ or Metals, only the Scala 2.13/JVM subprojects will be imported. This is controlled by the `ideSkipProject` setting in `build.sbt` (inside `commonSettings`).
Expand All @@ -133,7 +135,7 @@ The documentation is typechecked using [mdoc](https://scalameta.org/mdoc/). The

When generating documentation, it's best to set the version to the current one, so that the generated doc files don't include modifications with the current snapshot version.

That is, in sbt run: `set version := "4.0.0-M18"`, before running `mdoc` in `docs`.
That is, in sbt run: `set version := "4.0.0-M20"`, before running `mdoc` in `docs`.

### Testing the Scala.JS backend

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit e0c83f5

Please sign in to comment.