Skip to content

Commit

Permalink
mention next branch in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
arlyon committed Sep 3, 2024
1 parent 9cfd265 commit 6615d1d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,23 @@ the entire API surface. Not the case? Please open an issue. We update our
definitions [every week](https://github.com/arlyon/async-stripe/actions/workflows/openapi.yml) to ensure that we are up to date.
Want to see a changelog of the Stripe API? [Look no further](https://stripe.com/docs/changelog).

> **Note**
>
> We are currently working on a major rewrite of the library in the `next` branch. This rewrite aims to make the library more efficient and easier to use. Some lovely numbers from the rewrite:
>
> - A clean release build of `examples/endpoints` goes from ~4m to 50s with `min-ser` enabled.
> - The actual time to build just the binary goes from 75s to 7s, making incremental builds for code depending on async-stripe much faster.
> - Stripped binary size of the `examples/endpoints` binary went from ~70MB to ~20MB, with further reduction to ~13MB using a fat LTO build.
>
> We are actively seeking testers to help us ensure the new version is stable and performant. If you are interested in trying out the new version, you can add the following to your `Cargo.toml`:
>
> ```toml
> [dependencies]
> async-stripe = { git = "https://github.com/arlyon/async-stripe", branch = "next" }
> ```
>
> Your feedback is invaluable to us, so please report any issues or suggestions you may have. We are still expecting a few breaking changes before RC.
## Documentation
See the [Rust API docs](https://docs.rs/async-stripe), the [examples](/examples), or [payments.rs](https://payments.rs).
Expand Down

0 comments on commit 6615d1d

Please sign in to comment.