Skip to content

Commit 18f48e1

Browse files
committed
readme/release notes/.gitignore updates
1 parent 14d6ce2 commit 18f48e1

File tree

4 files changed

+14
-4
lines changed

4 files changed

+14
-4
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
.ensime
44
.ensime_cache/
55
scorex.yaml
6+
.bsp
67

78
# scala build folders
89
target
@@ -13,3 +14,7 @@ target
1314
# logs
1415
scorex-errors.log
1516
*.log
17+
18+
# local-only JS-related files and folders
19+
package-lock.json
20+
node_modules/

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Use the repository as code examples for the trees also, though one code example
1111

1212
## Get Scrypto
1313

14-
Scrypto is available on Sonatype for Scala 2.12:
14+
Scrypto is available on Sonatype for Scala 2.12 / 2.13:
1515
```scala
1616
resolvers += "Sonatype Releases" at "https://oss.sonatype.org/content/repositories/releases/"
1717
```
1818

1919
You can use Scrypto in your sbt project by simply adding the following dependency to your build file:
2020
```scala
21-
libraryDependencies += "org.scorexfoundation" %% "scrypto" % "2.2.0"
21+
libraryDependencies += "org.scorexfoundation" %% "scrypto" % "3.0.0"
2222
```
2323

2424
### Hash functions
@@ -208,7 +208,11 @@ added 285 packages, and audited 286 packages in 20s
208208
found 0 vulnerabilities
209209
```
210210

211-
Then you can compile the library with SBT and run tests.
211+
Then you can compile the library with SBT and run tests. Please note that Scala-JS compilation of JavaScript code
212+
may consume a lot of memory, so makes sense to give more memory to SBT by e.g. running
213+
`export SBT_OPTS="-Xmx3G -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled -XX:MaxPermSize=2G -Xss2M"` (to give 3G
214+
of RAM to it) before launching SBT.
215+
212216
```
213217
$sbt
214218
sbt:scrypto> compile

build.sbt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ lazy val scryptoJS = scrypto.js
8585
Compile / npmDependencies ++= Seq(
8686
"@noble/hashes" -> "1.1.4"
8787
),
88-
useYarn := true
88+
useYarn := false
8989
)
9090

9191
lazy val benchmarks = project

release-notes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
**3.0.0**
33
---------
44

5+
* Javascript support via Scala.JS
56
* CI configuration for Scala.js
67
* configuration of SBT with necessary JS dependencies (@noble/hashes) using ScalablyTyped
78
* removed all Java dependencies in `shared` code (jvm still uses BouncyCastle)

0 commit comments

Comments
 (0)