Open for comments

zio · Oct 21, 2024 · f4a3c38 · f4a3c38
1 parent 6e4a06d
commit f4a3c38
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,12 @@ archive formats with [ZIO Streams](https://zio.dev).
 
 [![Production Ready](https://img.shields.io/badge/Project%20Stage-Production%20Ready-brightgreen.svg)](https://github.com/zio/zio/wiki/Project-Stages) ![CI Badge](https://github.com/zio/zio-streams-compress/workflows/CI/badge.svg) [![Sonatype Releases](https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-streams-compress-docs_2.13.svg?label=Sonatype%20Release)](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-streams-compress-docs_2.13/) [![Sonatype Snapshots](https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-streams-compress-docs_2.13.svg?label=Sonatype%20Snapshot)](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-streams-compress-docs_2.13/) [![javadoc](https://javadoc.io/badge2/dev.zio/zio-streams-compress-docs_2.13/javadoc.svg)](https://javadoc.io/doc/dev.zio/zio-streams-compress-docs_2.13) [![ZIO Streams Compress docs](https://img.shields.io/github/stars/zio/zio-streams-compress?style=social)](https://github.com/zio/zio-streams-compress) [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
 
+# We are open for comments
+
+Please [open an issue](https://github.com/zio/zio-streams-compress/issues/new) or contact us
+on [Discord](https://discord.com/channels/629491597070827530/630498701860929559) if you have suggestions. The API will
+stabilize in Jan 2025, followed by a 1.0.0 release.
+
 ## Usage
 
 In order to use this library, we need to add one of the following line in our `build.sbt` file:
@@ -78,9 +84,9 @@ object ExampleApp extends ZIOAppDefault {
     } yield ()
 
   private def archiveEntry(
-      name: String,
-      content: Array[Byte]
-  ): (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]) = {
+                            name: String,
+                            content: Array[Byte]
+                          ): (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]) = {
     (ArchiveEntry(name, Some(content.length)), ZStream.fromIterable(content))
   }
 }

diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,5 @@
 ---
-id: index 
+id: index
 title: "Compression and archives with zio-streams"
 sidebar_label: "Getting Started"
 ---
@@ -9,6 +9,12 @@ archive formats with [ZIO Streams](https://zio.dev).
 
 @PROJECT_BADGES@ [![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
 
+# We are open for comments
+
+Please [open an issue](https://github.com/zio/zio-streams-compress/issues/new) or contact us
+on [Discord](https://discord.com/channels/629491597070827530/630498701860929559) if you have suggestions. The API will
+stabilize in Jan 2025, followed by a 1.0.0 release.
+
 ## Usage
 
 In order to use this library, we need to add one of the following line in our `build.sbt` file:
@@ -39,9 +45,9 @@ Currently only jvm is supported. PRs for scala-js and scala-native are welcome.
 ```scala
 // Example.sc
 // Run with: scala-cli Example.sc
-//> using dep dev.zio:zio-streams-compress-gzip:0.0.1
-//> using dep dev.zio:zio-streams-compress-zip:0.0.1
-//> using dep dev.zio:zio-streams-compress-tar:0.0.1
+//> using dep dev.zio:zio-streams-compress-gzip:@VERSION@
+//> using dep dev.zio:zio-streams-compress-zip:@VERSION@
+//> using dep dev.zio:zio-streams-compress-tar:@VERSION@
 
 import zio._
 import zio.compress.{ArchiveEntry, GzipCompressor, GzipDecompressor, TarUnarchiver, ZipArchiver}
@@ -78,9 +84,9 @@ object ExampleApp extends ZIOAppDefault {
     } yield ()
 
   private def archiveEntry(
-      name: String,
-      content: Array[Byte]
-  ): (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]) = {
+                            name: String,
+                            content: Array[Byte]
+                          ): (ArchiveEntry[Some, Any], ZStream[Any, Throwable, Byte]) = {
     (ArchiveEntry(name, Some(content.length)), ZStream.fromIterable(content))
   }
 }