Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
djgrant committed Feb 29, 2024
1 parent b983197 commit 6589ebc
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 29 deletions.
Binary file added .github/assets/code-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 25 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
<a href="https://discord.gg/mGzDWShPzm"><img alt="Discord" src="https://img.shields.io/discord/1154880135678406676"></a>
</h1>

### JavaScript-native development for cloud-native deployment

Notation is an experimental serverless toolkit designed for JavaScript's culture and ecosystem.

[Website](https://notation.dev)<sup>↗</sup>&nbsp;&nbsp;
[Quick Start](#quick-start)<sup>↓</sup>&nbsp;&nbsp;
[Slow Start](https://notation.dev/docs/guide)<sup>↗</sup>&nbsp;&nbsp;
Expand All @@ -22,20 +26,33 @@

<br />

**Notation is an open source toolkit for building serverless applications.**<br />
It pairs scalable, managed infrastructure with a first-class developer experience.
## Features

### Infrastructure compiler

<br />
Generates cloud platform wiring from intuitive application-like code.

Uses inference and best practices to compile policy documents, ARN strings, IAM roles, permissions etc.

<img alt="Notation infra graph" src=".github/assets/code-infra-graph.png">

## What's in the toolkit?
<br />

### 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)<sup>↓</sup>**: Production-ready infra, generated from application-like code
- **[Serverless Providers](#-serverless-providers)<sup>↓</sup>**: Popular serverless technologies, unified in a type-safe framework
- **[Cloud Provisioner](#-cloud-provisioner)<sup>↓</sup>**: Cross-platform deployments, with _hot infra replacement_ for local dev
<img alt="Notation TS error" src=".github/assets/code-error.png">

## Quick Start

Expand All @@ -53,27 +70,6 @@ A walkthrough of the key features of Notation.
<img alt="Notation demo thumbnail" src=".github/assets/video-thumbnail.png" width="600">
</a>

## 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
Expand Down

0 comments on commit 6589ebc

Please sign in to comment.