Skip to content

Commit 0aa5d36

Browse files
committed
Update docs
1 parent 739a47e commit 0aa5d36

3 files changed

Lines changed: 15 additions & 10 deletions

File tree

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@
55
[![Maven Central](https://img.shields.io/maven-central/v/com.softwaremill.ox/core_3)](https://central.sonatype.com/artifact/com.softwaremill.ox/core_3)
66
[![ScalaDoc](https://javadoc.io/badge2/com.softwaremill.ox/core_3/ScalaDoc.svg)](https://javadoc.io/doc/com.softwaremill.ox/core_3)
77

8-
Safe direct-style streaming, concurrency and resiliency for Scala on the JVM. Requires JDK 21+ & Scala 3. Ox covers
9-
the following areas:
8+
Safe direct-style streaming, concurrency and resiliency for Scala on the JVM.
9+
Requires JDK 21+ & Scala 3. Experimental support for Scala Native.
10+
11+
Ox covers the following areas:
1012

1113
* streaming: push-based backpressured streaming designed for direct-style, with a rich set of stream transformations,
1214
flexible stream source & sink definitions and reactive streams integration
@@ -22,13 +24,13 @@ preserving developer-friendly stack traces, and without compromising performance
2224
To use Ox, add the following dependency, using either [sbt](https://www.scala-sbt.org):
2325

2426
```scala
25-
"com.softwaremill.ox" %% "core" % "1.0.4"
27+
"com.softwaremill.ox" %%% "core" % "1.0.4"
2628
```
2729

2830
Or [scala-cli](https://scala-cli.virtuslab.org):
2931

3032
```scala
31-
//> using dep "com.softwaremill.ox::core:1.0.4"
33+
//> using dep "com.softwaremill.ox:::core:1.0.4"
3234
```
3335

3436
Documentation is available at [https://ox.softwaremill.com](https://ox.softwaremill.com), ScalaDocs can be browsed at [https://javadoc.io](https://www.javadoc.io/doc/com.softwaremill.ox).
@@ -265,4 +267,4 @@ We offer commercial development services. [Contact us](https://softwaremill.com)
265267

266268
## Copyright
267269

268-
Copyright (C) 2023-2025 SoftwareMill [https://softwaremill.com](https://softwaremill.com).
270+
Copyright (C) 2023-2026 SoftwareMill [https://softwaremill.com](https://softwaremill.com).

doc/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Ox
22

3-
Safe direct-style streaming, concurrency and resiliency for Scala on the JVM. Requires JDK 21+ & Scala 3.
3+
Safe direct-style streaming, concurrency and resiliency for Scala on the JVM.
4+
Requires JDK 21+ & Scala 3. Experimental support for Scala Native.
45

5-
To start using Ox, add the `com.softwaremill.ox::core:@VERSION@` [dependency](info/dependency.md) to your project.
6+
To start using Ox, add the `com.softwaremill.ox:::core:@VERSION@` [dependency](info/dependency.md) to your project.
67
Then, take a look at the tour of Ox, or follow one of the topics listed in the menu to get to know Ox's API!
78

89
In addition to this documentation, ScalaDocs can be browsed at [https://javadoc.io](https://www.javadoc.io/doc/com.softwaremill.ox).

doc/info/dependency.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ To use ox core in your project, add:
44

55
```scala
66
// sbt dependency
7-
"com.softwaremill.ox" %% "core" % "@VERSION@"
7+
"com.softwaremill.ox" %%% "core" % "@VERSION@"
88

99
// scala-cli dependency
10-
//> using dep com.softwaremill.ox::core:@VERSION@
10+
//> using dep com.softwaremill.ox:::core:@VERSION@
1111
```
1212

13-
Ox core depends only on the Java [jox](https://github.com/softwaremill/jox) project, where channels are implemented. There are no other direct or transitive dependencies.
13+
On the JVM, Ox core depends only on the Java [jox](https://github.com/softwaremill/jox) project, where channels are implemented. There are no other direct or transitive dependencies.
14+
15+
For Scala Native, only the the `core` module is available. It contains a reimplementation of Jox Channels in pure Scala.
1416

1517
Integration modules have separate dependencies.

0 commit comments

Comments
 (0)