You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-5
Original file line number
Diff line number
Diff line change
@@ -12,16 +12,22 @@ Throughout the [docs](https://www.twilio.com/docs/labs/serverless-toolkit), you
12
12
13
13
## Let's work together
14
14
15
-
Everything in this toolkit is released under [Twilio Labs](https://www.twilio.com/docs/labs) and fully open-source. If you find any problems with this, [please file an issue](https://github.com/twilio-labs/twilio-run/issues) or even create a pull request to work together with us on the toolkit. We would love to hear your ideas and feedback!
15
+
Everything in this toolkit is released under [Twilio Labs](https://www.twilio.com/docs/labs) and fully open-source. If you find any problems with this, [please file an issue](https://github.com/twilio-labs/serverless-toolkit/issues) or even create a pull request to work together with us on the toolkit. We would love to hear your ideas and feedback!
16
16
17
17
## Project Structure & Contributing
18
18
19
19
This project is a monorepo, meaning it contains multiple packages in one repository. It consists out of the following packages:
20
20
21
21
-[`twilio-run`](packages/twilio-run) - The underlying CLI tool
22
-
-[`plugin-serverless`](https://github.com/twilio-labs/plugin-serverless) - Exposes the `twilio-run` CLI into the [Twilio CLI](https://www.twilio.com/docs/twilio-cli)
23
-
-[`create-twilio-function`](https://github.com/twilio-labs/create-twilio-function) - Handles templating and bootstrapping of new projects and Functions
24
-
-[`serverless-api`](https://github.com/twilio-labs/serverless-api) - The module used to interact with the actual [Serverless API](https://github.com/twilio-labs/serverless-api)
22
+
-[`plugin-serverless`](packages/plugin-serverless) - Exposes the `twilio-run` CLI into the [Twilio CLI](https://www.twilio.com/docs/twilio-cli)
23
+
-[`create-twilio-function`](packages/create-twilio-function) - Handles templating and bootstrapping of new projects and Functions
24
+
-[`serverless-api`](packages/serverless-api) - The module used to interact with the actual [Twilio Functions and Assets API](https://www.twilio.com/docs/runtime/functions-assets-api)
25
+
-[`runtime-handler`](packages/runtime-handler) - A version of the [Twilio Functions Runtime Handler](https://www.twilio.com/docs/runtime/runtime-handler) to be used in local development
26
+
-[`plugin-assets`](packages/plugin-assets) - A plugin for the Twilio CLI to easily upload assets to a Twilio Assets service
27
+
-[`serverless-runtime-types`](packages/serverless-runtime-types) - TypeScript definitions to define globals for the Twilio Serverless runtime
28
+
29
+
Also part of the Serverless toolkit, but in another repository:
30
+
25
31
-[`function-templates`](https://github.com/twilio-labs/function-templates) - The templates used by the toolkit to create new Functions
26
32
27
33
To understand more about the structure and the design of the Toolkit check out the [design documentation](docs/DESIGN.md).
@@ -31,7 +37,7 @@ To understand more about the structure and the design of the Toolkit check out t
31
37
This project uses [`lerna`](https://npm.im/lerna) as a tool to manage the monorepo. If you are unfamiliar with the tool, start by checking out the the [lerna docs](https://lerna.js.org/).
|[`@twilio-labs/plugin-serverless`](plugin-serverless)|[Twilio CLI](https://www.twilio.com/docs/cli) Plugin that wraps `create-twilio-function` and `twilio-run`|[Changelog](@twilio-labs/plugin-serverless/CHANGELOG.md)| <br> |
8
+
| [`@twilio-labs/plugin-assets`](plugin-assets) | [Twilio CLI](https://www.twilio.com/docs/cli) Plugin that makes it easy to upload assets to a Twilio Assets service | [Changelog](plugin-assets/CHANGELOG.md) |  <br> 
8
9
|[`@twilio-labs/serverless-api`](serverless-api)| Wrapper library to work with the [Functions & Assets API from Twilio](https://twilio.com/docs/runtime/functions-assets-api)|[Changelog](@twilio-labs/serverless-api/CHANGELOG.md)| <br> |
9
10
|[`@twilio-labs/serverless-runtime-types`](serverless-runtime-types)| TypeScript types representing the Twilio Runtime for Functions |[Changelog](@twilio-labs/serverless-runtime-types/CHANGELOG.md)| <br> |
10
11
|[`@twilio-labs/serverless-twilio-runtime`](serverless-twilio-runtime)| Integration for the [Serverless](https://serverless.com) Platform. |[Changelog](@twilio-labs/serverless-twilio-runtime/CHANGELOG.md)| <br> |
11
12
|[`create-twilio-function`](create-twilio-function)| CLI tool to create new Twilio Functions projects |[Changelog](create-twilio-function/CHANGELOG.md)| <br> |
12
13
|[`twilio-run`](twilio-run)| CLI tool to develop, debug and deploy Twilio Serverless products |[Changelog](twilio-run/CHANGELOG.md)| <br> |
14
+
|[`runtime-handler`](runtime-handler)| A version of the [Twilio Functions Runtime Handler](https://www.twilio.com/docs/runtime/runtime-handler) to be used in local development |[Changelog](runtime-handler/CHANGELOG.md)| <br> |
Copy file name to clipboardExpand all lines: packages/twilio-run/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ Check out the [commands](#commands) for in depth usage, but here are some things
61
61
62
62
### Create a new project
63
63
64
-
To create a new project with the Twilio Serverless Toolkit you can use [`create-twilio-function`](https://github.com/twilio-labs/create-twilio-function/) which will scaffold a new project that is ready to be used with `twilio-run`.
64
+
To create a new project with the Twilio Serverless Toolkit you can use [`create-twilio-function`](https://github.com/twilio-labs/serverless-toolkit/tree/main/packages/create-twilio-function) which will scaffold a new project that is ready to be used with `twilio-run`.
0 commit comments