Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add beta README.md section #2562

Merged
merged 4 commits into from
Aug 23, 2022
Merged

Add beta README.md section #2562

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f1a29b7
Add beta readme.md section
pakrym-stripe Aug 22, 2022
477ae77
fb
pakrym-stripe Aug 22, 2022
88601e9
,
pakrym-stripe Aug 22, 2022
5c3c18b
Merge branch 'master' into pakrym/Add_beta_readme.md_section
pakrym-stripe Aug 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@

The official [Stripe][stripe] .NET library, supporting .NET Standard 2.0+, .NET Core 2.0+, and .NET Framework 4.6.1+.

## Support

New features and bug fixes are released on the latest major version of the Stripe .NET client 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.

## Installation

Using the [.NET Core command-line interface (CLI) tools][dotnet-core-cli-tools]:
Expand Down Expand Up @@ -143,6 +139,30 @@ This information is passed along when the library makes calls to the Stripe
API. Note that while `Name` is always required, `Url` and `Version` are
optional.

### 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 of Stripe.net use the version parameter with `dotnet add package` command:

```
dotnet add package Stripe.net --version 40.3.0-beta.1
```

> Note: There can be breaking changes between beta versions. Therefore we recommend pinning the package version to a specific beta version in your project file. 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 `StripeConfiguration.ApiVersion` property to set it:

```csharp
StripeConfiguration.ApiVersion += "; feature_beta=v3";
```

## Support

New features and bug fixes are released on the latest major version of the Stripe .NET client 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][stripe-mock], so make sure to fetch
Expand Down