Skip to content

Commit

Permalink
readme/release notes/.gitignore updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kushti committed Sep 22, 2024
1 parent 14d6ce2 commit 18f48e1
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 4 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
.ensime
.ensime_cache/
scorex.yaml
.bsp

# scala build folders
target
Expand All @@ -13,3 +14,7 @@ target
# logs
scorex-errors.log
*.log

# local-only JS-related files and folders
package-lock.json
node_modules/
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Use the repository as code examples for the trees also, though one code example

## Get Scrypto

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

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

### Hash functions
Expand Down Expand Up @@ -208,7 +208,11 @@ added 285 packages, and audited 286 packages in 20s
found 0 vulnerabilities
```

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

```
$sbt
sbt:scrypto> compile
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ lazy val scryptoJS = scrypto.js
Compile / npmDependencies ++= Seq(
"@noble/hashes" -> "1.1.4"
),
useYarn := true
useYarn := false
)

lazy val benchmarks = project
Expand Down
1 change: 1 addition & 0 deletions release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
**3.0.0**
---------

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

0 comments on commit 18f48e1

Please sign in to comment.