Skip to content

Commit

Permalink
Merge pull request #60 from aws4embeddedlinux/2023-11-23_add_note_abo…
Browse files Browse the repository at this point in the history
…ut_node

README.md: add note about node versions
  • Loading branch information
thomas-roos authored Nov 23, 2023
2 parents 0201170 + b8a92d8 commit 21e981b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ This [cdk](https://github.com/aws/aws-cdk) IaC library helps you to deploy AWS c
[API documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci/) generated by `npm run doc`

# Setting Up
In order to use this library, you must set up the [CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html), including
installing the CDK tool and bootstrapping the account you wish to deploy to. Additionally, you must have [Node](https://nodejs.org/en/) installed.

> [!NOTE]
> This library is tested against Node Versions 16, 18, and 20. If these versions are not available for your system, we recommend
> using [NVM](https://github.com/nvm-sh/nvm) to install a compatible version
## Quickstart
Use the [examples](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) in our examples repo.
Expand Down

0 comments on commit 21e981b

Please sign in to comment.