Merge pull request #2 from sjrd/prepare-for-1.0.0

Prepare for 1.0.0

Author: sjrd

.github/workflows/ci.yml

@@ -19,18 +19,6 @@ jobs:
         with:
           java-version: "[email protected]"
       - uses: coursier/cache-action@v5
-      - uses: actions/checkout@v2
-        with:
-          repository: scala-js/scala-js
-          ref: e38b86aef95ac074fe84e7fda3e22e08a723a91b
-          path: ./scalajs-nightly
-      - name: publishLocal Scala.js nightly
-        run: |
-          sbt ";ir2_12/publishLocal;linkerInterface2_12/publishLocal;linker2_12/publishLocal;testAdapter2_12/publishLocal;sbtPlugin/publishLocal"
-          sbt ";compiler2_11/publishLocal;library2_11/publishLocal;testInterface2_11/publishLocal;testBridge2_11/publishLocal;jUnitRuntime2_11/publishLocal;jUnitPlugin2_11/publishLocal"
-          sbt ";compiler2_12/publishLocal;library2_12/publishLocal;testInterface2_12/publishLocal;testBridge2_12/publishLocal;jUnitRuntime2_12/publishLocal;jUnitPlugin2_12/publishLocal"
-          sbt ";compiler2_13/publishLocal;library2_13/publishLocal;testInterface2_13/publishLocal;testBridge2_13/publishLocal;jUnitRuntime2_13/publishLocal;jUnitPlugin2_13/publishLocal"
-        working-directory: ./scalajs-nightly
       - name: Test JVM
         run: sbt "++${{ matrix.scalaversion }}" testSuiteJVM/test
       - name: Test JS

README.md

@@ -5,6 +5,18 @@
 It assumes that the target platform supports JavaScript's `WeakRef` and `FinalizationRegistry`, which are becoming standard in ECMAScript 2021.
 Attempts to use `WeakReference` or `ReferenceQueue` will throw `ReferenceError`s if they are not supported.
 
+## Usage
+
+Add the following dependency to your project settings:
+
+```scala
+libraryDependencies += "org.scala-js" %%% "scalajs-weakreferences" % "1.0.0-SNAPSHOT"
+```
+
+When using a `crossProject`, add the above in `.jsSettings(...)`.
+
+You can then use `java.lang.ref.WeakReference` and `java.lang.ref.ReferenceQueue`.
+
 ## License
 
 `scalajs-weakreferences` is distributed under the [Apache 2.0 license](./LICENSE.txt), like Scala.js itself.

project/plugins.sbt

@@ -1,4 +1,4 @@
-addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.6.0-SNAPSHOT")
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.6.0")
 addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject" % "1.0.0")
 
 addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.6.0")