Expand the README to include some pointers on getting started with CDK

[pcholakov]

The information published at https://www.npmjs.com/package/@restatedev/restate-cdk is very sparse; it should contain some pointers on getting started with the CDK and probably a link to restatedev/examples#50 once merged.

[pcholakov]

PR: #20

[pcholakov]

Also added a new page to the doc website: restatedev/documentation#234

[pcholakov]

Merged but won't release a new npm artifact until we have released the documentation (which is in turned blocked on releasing the runtime with the latest interface changes).

[tillrohrmann]

Why is the CDK release blocked on the documentation release @pcholakov?

[pcholakov]

The updated README links to the as-yet-unpublished CDK page introduced by restatedev/documentation#234 – do you think it's enough of an improvement to release even with a broken link?

Here's the CDK-with-Lambda reference page: https://10ac2971.documentation-beg.pages.dev/services/deployment/cdk

[tillrohrmann]

The broken link is not perfect but strictly speaking it already exists when looking at the README in main of this repo. Given that the README already contains a lot of helpful information compared to the is-state (released artifact), I would be fine with creating a release with a temporarily broken link.

[pcholakov]

You are quite right! I just had a mental block against pushing out the broken link – this is still a strict improvement.

v0.4.2 release kicked off: https://github.com/restatedev/cdk/actions/runs/7388711431

[pcholakov]

Much better! https://www.npmjs.com/package/@restatedev/restate-cdk

[tillrohrmann]

Much better! https://www.npmjs.com/package/@restatedev/restate-cdk

Cool :-)