diff --git a/.github/assets/code-error.png b/.github/assets/code-error.png new file mode 100644 index 0000000..318d9aa Binary files /dev/null and b/.github/assets/code-error.png differ diff --git a/README.md b/README.md index d3cfde6..56e96b1 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ Discord +### JavaScript-native development for cloud-native deployment + +Notation is an experimental serverless toolkit designed for JavaScript's culture and ecosystem. + [Website](https://notation.dev) •  [Quick Start](#quick-start) •  [Slow Start](https://notation.dev/docs/guide) •  @@ -22,20 +26,33 @@
-**Notation is an open source toolkit for building serverless applications.**
-It pairs scalable, managed infrastructure with a first-class developer experience. +## Features + +### Infrastructure compiler -
+Generates cloud implementation details from intuitive-to-write code. + +Using inference and best practices, compiles policy documents, ARN strings, IAM roles, permissions etc. Notation infra graph -## What's in the toolkit? +
+ +### Hot infra replacement + +Deploys both production and ephemeral dev stacks. + +Built from the ground up and designed for fast iteration cycles, hot infra replacement updates live dev stacks while you code. + +https://github.com/notation-dev/notation/assets/1670902/fd8c955f-8aa9-4800-813a-ea96c2b398cc + +### End-to-end types + +Brings together popular serverless technologies in a unified type space. -Notation provides the following tools: +Provides well-designed types for every resource, and ensures compatibility between infrastructure and runtime modules. -- **[Infrastructure Compiler](#-infrastructure-compiler)**: Production-ready infra, generated from application-like code -- **[Serverless Providers](#-serverless-providers)**: Popular serverless technologies, unified in a type-safe framework -- **[Cloud Provisioner](#-cloud-provisioner)**: Cross-platform deployments, with _hot infra replacement_ for local dev +Notation TS error ## Quick Start @@ -53,27 +70,6 @@ A walkthrough of the key features of Notation. Notation demo thumbnail -## Features - -### 🤖 Infrastructure Compiler - -- Generates cloud-specific implementation details -- Uses inference and best practices to compile policy documents, ARN strings, IAM roles, permissions etc. - -### 🧩 Serverless Providers - -- A selection of popular serverless resources – e.g. lambda, event bridge, API gateway -- Resources are fully-typed, making them easy to configure and connect to other resources -- Type checking even works between infrastructure and runtime modules - -### 🚀 Cloud Provisioner - -- Deploys production and ephemeral dev stacks -- Built from the ground up and designed for fast iteration cycles -- Hot infra replacement updates live dev stacks while you code - -https://github.com/notation-dev/notation/assets/1670902/fd8c955f-8aa9-4800-813a-ea96c2b398cc - ## Community - **[Discussions](https://github.com/notation-dev/notation/discussions)**: ask questions, give feedback on RFCs, suggest ideas