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

Update readme to include a note on beta packages #1471

Merged
merged 4 commits into from
Jul 12, 2022
Merged

Update readme to include a note on beta packages #1471

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0bc1df2
Update readme to include a note on beta packages
ramya-stripe Jul 11, 2022
e572a2c
Add the missing -
ramya-stripe Jul 11, 2022
18bd2b6
Be clearer on what needs to be pinned
ramya-stripe Jul 11, 2022
814a4a3
Clarify between package and version
ramya-stripe Jul 12, 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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ npm install stripe --save
yarn add stripe
```

### Beta version

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.
The beta versions can be installed in one of two ways
- To install the latest beta version, run the command `npm install stripe@beta --save`
- To install a specific beta version, replace the term "beta" in the above command with the version number like `npm install [email protected] --save`

> Note: There can be breaking changes between beta packages. Therefore we recommend pinning the beta version to a specific version in your package.json file so that you can install the same version each time without breaking changes unless you are intentionally looking for the latest beta package.
ramya-stripe marked this conversation as resolved.
Show resolved Hide resolved

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.

The versions tab on the [stripe page on npm](https://www.npmjs.com/package/stripe) lists the current tags in use. The `beta` tag here corresponds to the the latest beta version of the package.

## Usage

The package needs to be configured with your account's secret key, which is
Expand Down