Skip to content

Commit 7f9205e

Browse files
authored
chore(readmes): updates READMEs (#323)
1 parent 8d2d762 commit 7f9205e

File tree

3 files changed

+14
-6
lines changed

3 files changed

+14
-6
lines changed

Diff for: README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,22 @@ Throughout the [docs](https://www.twilio.com/docs/labs/serverless-toolkit), you
1212

1313
## Let's work together
1414

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!
1616

1717
## Project Structure & Contributing
1818

1919
This project is a monorepo, meaning it contains multiple packages in one repository. It consists out of the following packages:
2020

2121
- [`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+
2531
- [`function-templates`](https://github.com/twilio-labs/function-templates) - The templates used by the toolkit to create new Functions
2632

2733
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
3137
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/).
3238

3339
```bash
34-
git clone [email protected]:twilio-labs/twilio-run.git serverless-toolkit
40+
git clone [email protected]:twilio-labs/serverless-toolkit.git serverless-toolkit
3541
cd serverless-toolkit
3642
npm install
3743
npm run bootstrap

Diff for: packages/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ This repository is structured as a monorepo using [Lerna](https://lerna.js.org)
55
| Package | Description | Changelog | |
66
| :-------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
77
| [`@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) | ![npm](https://img.shields.io/npm/v/@twilio-labs/plugin-serverless?color=red&label=@twilio-labs/plugin-serverless&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/@twilio-labs/plugin-serverless?style=flat-square) |
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) | ![npm](https://img.shields.io/npm/v/@twilio-labs/plugin-assets?color=red&label=@twilio-labs/plugin-assets&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/@twilio-labs/plugin-assets?style=flat-square)
89
| [`@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) | ![npm](https://img.shields.io/npm/v/@twilio-labs/serverless-api?color=red&label=@twilio-labs/serverless-api&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/@twilio-labs/serverless-api?style=flat-square) |
910
| [`@twilio-labs/serverless-runtime-types`](serverless-runtime-types) | TypeScript types representing the Twilio Runtime for Functions | [Changelog](@twilio-labs/serverless-runtime-types/CHANGELOG.md) | ![npm](https://img.shields.io/npm/v/@twilio-labs/serverless-runtime-types?color=red&label=@twilio-labs/serverless-runtime-types&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/@twilio-labs/serverless-runtime-types?style=flat-square) |
1011
| [`@twilio-labs/serverless-twilio-runtime`](serverless-twilio-runtime) | Integration for the [Serverless](https://serverless.com) Platform. | [Changelog](@twilio-labs/serverless-twilio-runtime/CHANGELOG.md) | ![npm](https://img.shields.io/npm/v/@twilio-labs/serverless-twilio-runtime?color=red&label=@twilio-labs/serverless-twilio-runtime&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/@twilio-labs/serverless-twilio-runtime?style=flat-square) |
1112
| [`create-twilio-function`](create-twilio-function) | CLI tool to create new Twilio Functions projects | [Changelog](create-twilio-function/CHANGELOG.md) | ![npm](https://img.shields.io/npm/v/create-twilio-function?color=red&label=create-twilio-function&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/create-twilio-function?style=flat-square) |
1213
| [`twilio-run`](twilio-run) | CLI tool to develop, debug and deploy Twilio Serverless products | [Changelog](twilio-run/CHANGELOG.md) | ![npm](https://img.shields.io/npm/v/twilio-run?color=red&label=twilio-run&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/twilio-run?style=flat-square) |
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) | ![npm](https://img.shields.io/npm/v/@twilio/runtime-handler?color=red&label=@twilio/runtime-handler&style=flat-square) <br> ![npm](https://img.shields.io/npm/dm/@twilio/runtime-handler?style=flat-square) |

Diff for: packages/twilio-run/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Check out the [commands](#commands) for in depth usage, but here are some things
6161

6262
### Create a new project
6363

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`.
6565

6666
```bash
6767
# Create a valid project, for example:

0 commit comments

Comments
 (0)