You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-23Lines changed: 6 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,36 +1,24 @@
1
1
# rescript-bun
2
2
3
-
_Check out the `2.x` branch for ReScript v12 support._
4
-
5
-
## Release Branches
6
-
7
-
This repository maintains two active release branches:
8
-
-**`main` branch**: For 1.x releases (ReScript v11+ support)
9
-
-**`2.x` branch**: For 2.x releases (ReScript v12+ support)
10
-
11
-
Each branch has independent release cycles managed by changesets. See [DUAL_BRANCH_SETUP.md](DUAL_BRANCH_SETUP.md) for detailed information about the dual-branch setup.
12
-
13
3
Use [Bun](https://bun.sh) with ReScript.
14
4
15
-
> **Currently alpha state software**. You're encouraged to start using it, but please report all issues. There will be both bindings missing and some bindings will probably be wrong/suboptimal. We're going to work through the API surface as we go. Report all issues you find!
16
-
17
5
## Getting started
18
6
19
7
**Template repo to get up and running quickly: https://github.com/zth/rescript-bun-starter**
20
8
21
-
You need to be on ReScript v11`>=11.1.0` and Core `>=1.3.0`. This is designed for uncurried mode so you should use that as well (`"uncurried": true` in your bsconfig/`rescript.json`).
@@ -218,7 +202,7 @@ Currently, bindings exist for the most common things. There's still a good amoun
218
202
219
203
## Other things to figure out
220
204
221
-
- How to reuse/contribute to [`rescript-webapi`](https://github.com/TheSpyder/rescript-webapi) instead of rolling our own bindings. I've intentionally not reused any other existing library because I wanted to start from scratch and follow ReScript v11 idioms as much as possible. But once all of this settles, we need to figure out and share the common denominator with `rescript-webapi` and other similar projects to this.
205
+
- How to reuse/contribute to [`rescript-webapi`](https://github.com/TheSpyder/rescript-webapi) instead of rolling our own bindings. I've intentionally not reused any other existing library because I wanted to start from scratch and follow ReScript v11+ idioms as much as possible. But once all of this settles, we need to figure out and share the common denominator with `rescript-webapi` and other similar projects to this.
222
206
223
207
## Contributing
224
208
@@ -230,7 +214,6 @@ If you do want to contribute, _please open an issue saying you're starting work
230
214
231
215
This project uses [Changesets](https://github.com/changesets/changesets) to manage versions and changelogs. Run `npm run changeset` to create a changeset describing your changes. When changes are merged to `main`, a GitHub Action opens a release PR and merging that will publish a new version.
0 commit comments