Skip to content

Commit 6589ebc

Browse files
committed
Update readme
1 parent b983197 commit 6589ebc

2 files changed

Lines changed: 25 additions & 29 deletions

File tree

.github/assets/code-error.png

199 KB
Loading

README.md

Lines changed: 25 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
<a href="https://discord.gg/mGzDWShPzm"><img alt="Discord" src="https://img.shields.io/discord/1154880135678406676"></a>
1414
</h1>
1515

16+
### JavaScript-native development for cloud-native deployment
17+
18+
Notation is an experimental serverless toolkit designed for JavaScript's culture and ecosystem.
19+
1620
[Website](https://notation.dev)<sup>↗</sup>&nbsp;&nbsp;
1721
[Quick Start](#quick-start)<sup>↓</sup>&nbsp;&nbsp;
1822
[Slow Start](https://notation.dev/docs/guide)<sup>↗</sup>&nbsp;&nbsp;
@@ -22,20 +26,33 @@
2226

2327
<br />
2428

25-
**Notation is an open source toolkit for building serverless applications.**<br />
26-
It pairs scalable, managed infrastructure with a first-class developer experience.
29+
## Features
30+
31+
### Infrastructure compiler
2732

28-
<br />
33+
Generates cloud platform wiring from intuitive application-like code.
34+
35+
Uses inference and best practices to compile policy documents, ARN strings, IAM roles, permissions etc.
2936

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

32-
## What's in the toolkit?
39+
<br />
40+
41+
### Hot infra replacement
42+
43+
Deploys both production and ephemeral dev stacks.
44+
45+
Built from the ground up and designed for fast iteration cycles, hot infra replacement updates live dev stacks while you code.
46+
47+
https://github.com/notation-dev/notation/assets/1670902/fd8c955f-8aa9-4800-813a-ea96c2b398cc
48+
49+
### End-to-end types
50+
51+
Brings together popular serverless technologies in a unified type space.
3352

34-
Notation provides the following tools:
53+
Provides well-designed types for every resource, and ensures compatibility between infrastructure and runtime modules.
3554

36-
- **[Infrastructure Compiler](#-infrastructure-compiler)<sup>↓</sup>**: Production-ready infra, generated from application-like code
37-
- **[Serverless Providers](#-serverless-providers)<sup>↓</sup>**: Popular serverless technologies, unified in a type-safe framework
38-
- **[Cloud Provisioner](#-cloud-provisioner)<sup>↓</sup>**: Cross-platform deployments, with _hot infra replacement_ for local dev
55+
<img alt="Notation TS error" src=".github/assets/code-error.png">
3956

4057
## Quick Start
4158

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

56-
## Features
57-
58-
### 🤖 Infrastructure Compiler
59-
60-
- Generates cloud-specific implementation details
61-
- Uses inference and best practices to compile policy documents, ARN strings, IAM roles, permissions etc.
62-
63-
### 🧩 Serverless Providers
64-
65-
- A selection of popular serverless resources – e.g. lambda, event bridge, API gateway
66-
- Resources are fully-typed, making them easy to configure and connect to other resources
67-
- Type checking even works between infrastructure and runtime modules
68-
69-
### 🚀 Cloud Provisioner
70-
71-
- Deploys production and ephemeral dev stacks
72-
- Built from the ground up and designed for fast iteration cycles
73-
- Hot infra replacement updates live dev stacks while you code
74-
75-
https://github.com/notation-dev/notation/assets/1670902/fd8c955f-8aa9-4800-813a-ea96c2b398cc
76-
7773
## Community
7874

7975
- **[Discussions](https://github.com/notation-dev/notation/discussions)**: ask questions, give feedback on RFCs, suggest ideas

0 commit comments

Comments
 (0)