Merge pull request #43 from aws4embeddedlinux/add-nxp-example

Add NXP IMX example project.

README.md

@@ -1,21 +1,30 @@
-## My Project
+## aws4embeddedlinux-ci
 
-TODO: Fill this README out!
+This [cdk](https://github.com/aws/aws-cdk) IaC library help you to deploy AWS cloud infrastructure to allow embedded Linux builds for your project.
 
+### Architecture
+![architecture overview](architecture.drawio.svg "Architecture")
 
-### Development Setup
+### Quickstart
+Use the [examples](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) in our examples repo.
 
-You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a checked out copy of this repo.
+### Development Setup
+You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a local copy of this repo.
 
+#### In this library repo:
 ```bash
-# In this library repo:
 $ npm link
 $ cd your-project
+```
+
+#### In your-project folder:
+```bash
 $ npm link aws4embeddedlinux-ci
 ```
 
 This will link through the system `node_modules` install. When using a system node install on Linux, this can require sudo access. To avoid this, use a [node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-version-manager-to-install-nodejs-and-npm) or [set a node prefix](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally).
 
+
 ## Security
 
 See [SECURITY](SECURITY.md) for more information about reporting issues with this project.
@@ -55,4 +64,4 @@ See [CONTRIBUTING](CONTRIBUTING.md) for more information.
 
 ## License
 
-This library is licensed under the MIT-0 License. See the LICENSE file.
+This library is licensed under the MIT-0 License. See the [LICENSE](LICENSE) file.