sharpetronics/stripe-ruby
1
0
Fork 0
mirror of https://github.com/stripe/stripe-ruby.git synced 2025-10-04 00:00:47 -04:00
Code Issues Projects Releases Wiki Activity

Add beta readme.md section (#1121)

Browse Source
This commit is contained in:
pakrym-stripe 2022-08-23 09:34:02 -07:00 committed by GitHub
parent cfeaa0ca23
commit 53ab9bf668
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -16,10 +16,6 @@ The library also provides other features. For example:
- Built-in mechanisms for the serialization of parameters according to the
expectations of Stripe's API.
## Support
New features and bug fixes are released on the latest major version of the Stripe Ruby library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
## Documentation
See the [Ruby API docs](https://stripe.com/docs/api?lang=ruby).
@ -297,6 +293,30 @@ You can disable this behavior if you prefer:
Stripe.enable_telemetry = false
```
### Beta SDKs
Stripe has features in the beta phase that can be accessed via the beta version of this package.
We would love for you to try these and share feedback with us before these features reach the stable phase.
To install a beta version use `gem install` with the exact version you'd like to use:
```sh
gem install stripe -v 7.1.0.pre.beta.2
```
> Note: There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your Gemfile. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta version.
We highly recommend keeping an eye on when the beta feature you are interested in goes from beta to stable so that you can move from using a beta version of the SDK to the stable version.
If your beta feature requires a `Stripe-Version` header to be sent, use the `Stripe.api_version` field to set it:
```python
Stripe.api_version += "; feature_beta=v3"
```
## Support
New features and bug fixes are released on the latest major version of the Stripe Ruby library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
## Development
The test suite depends on [stripe-mock], so make sure to fetch and run it from a