From 615ce3993be55bf8f8fc36be7bfdeb52d83404b2 Mon Sep 17 00:00:00 2001
From: David Moore <4121492+davemooreuws@users.noreply.github.com>
Date: Fri, 5 Jul 2024 10:37:48 +1000
Subject: [PATCH] chore: update readme (#228)

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 52 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 3e1f3be2..b034e3b2 100644
--- a/README.md
+++ b/README.md
@@ -27,20 +27,64 @@ Nitric SDKs provide an infrastructure-as-code style that lets you define resourc
 
 You can request the type of access you need to resources such as publishing for topics, without dealing directly with IAM or policy documents.
 
-## Status
+- Reference Documentation: https://nitric.io/docs/reference/nodejs
+- Guides: https://nitric.io/docs/guides/nodejs
 
-The SDK is in early stage development and APIs and interfaces are still subject to breaking changes. We’d love your feedback as we build additional functionality!
+## Usage
+
+### Starting a new project
+
+Install the [Nitric CLI](https://nitric.io/docs/getting-started/installation), then generate your project:
+
+TypeScript:
+
+```bash
+nitric new hello-world ts-starter
+```
+
+JavaScript:
+
+```bash
+nitric new hello-world js-starter
+```
+
+### Adding to an existing project
+
+First of all, you need to install the library:
+
+```bash
+npm install @nitric/sdk
+```
+
+Then you're able to import the library and create cloud resources:
+
+```typescript
+import { api, bucket } from '@nitric/sdk';
+
+const publicApi = api('public');
+const uploads = bucket('uploads').allow('write');
+
+publicApi.get('/upload', async (ctx) => {
+  const photo = uploads.file('images/photo.png');
+
+  const url = await photo.getUploadUrl({
+    expiry: 300,
+  });
+
+  return ctx.res.json({ url });
+});
+```
+
+## Learn more
+
+Learn more by checking out the [Nitric documentation](https://nitric.io/docs).
 
 ## Get in touch:
 
-- Ask questions in [GitHub discussions](https://github.com/nitrictech/nitric/discussions)
+- Join us on [Discord](https://nitric.io/chat)
 
-- Join us on [Discord](https://discord.gg/Webemece5C)
+- Ask questions in [GitHub discussions](https://github.com/nitrictech/nitric/discussions)
 
 - Find us on [Twitter](https://twitter.com/nitric_io)
 
 - Send us an [email](mailto:maintainers@nitric.io)
-
-## Get Started
-
-Check out the [Nitric docs](https://nitric.io/docs) to see how to get started using Nitric.