Skip to content

Commit

Permalink
Update README (#2913)
Browse files Browse the repository at this point in the history
* Made it clear in the README that the requirement for yarn is related to running the Development environment

* Added table and info about our versioning strategy

* Some copy changes

* Copy change
  • Loading branch information
sponglord authored Oct 24, 2024
1 parent ae75bea commit b260140
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ You can integrate with Adyen Web in two ways:
- [API key](https://docs.adyen.com/development-resources/how-to-get-the-api-key)
- [Client key](https://docs.adyen.com/development-resources/client-side-authentication#get-your-client-key)

## Drop-in/Components lifecycle
| Major version | State | Deprecated | End-of-life |
|---------------|------------|--------------|--------------|
| 6.x.x | Active | --- | --- |
| 5.x.x | Inactive | TBA | TBA |
| 4.x.x | Inactive | TBA | TBA |
| 3.x.x | Deprecated | October 2024 | October 2025 |

More information about our versioning and the Drop-in/Components lifecycle can be found [here](https://docs.adyen.com/online-payments/upgrade-your-integration/)


## Installation

We only provide full support when you use one of these methods of installation.
Expand All @@ -36,18 +47,18 @@ import { AdyenCheckout } from '@adyen/adyen-web';
import '@adyen/adyen-web/styles/adyen.css';
```

### Using a <script> tag
### Using a `<script>` tag

You can also import Adyen Web using a `<script>` tag, as shown in the [Web Components integration guide](https://docs.adyen.com/checkout/components-web#step-2-add-components).

## Development
## Running the Development Environment

Requirements:
**Requirements:**

- Node v20.12.2
- Yarn

To run the development environment:
**To run the environment:**

1. Clone [this repository](https://github.com/Adyen/adyen-web).
2. Create a `.env` file on your project's root folder following the example in [`env.default`](env.default) and fill in the environment variables.
Expand Down Expand Up @@ -184,11 +195,11 @@ Have a look at our [contributing guidelines](https://github.com/Adyen/.github/bl

## See also

- [Why we open sourced Adyen Web](https://www.adyen.com/blog/why-we-opened-sourced-our-web-framework)
- [Complete documentation for Adyen Web](https://docs.adyen.com/checkout/)
- [API Explorer](https://docs.adyen.com/api-explorer/)
- [Example integrations](https://github.com/adyen-examples)
- [Adyen Components JS Sample Code](https://github.com/Adyen/adyen-components-js-sample-code)
- [Why we open sourced Adyen Web](https://www.adyen.com/blog/why-we-opened-sourced-our-web-framework)

## Support

Expand Down

0 comments on commit b260140

Please sign in to comment.