Skip to content

Commit 01ed72f

Browse files
committed
docs: add @dkundel as a contributor
1 parent 9aeb5a9 commit 01ed72f

File tree

2 files changed

+118
-1
lines changed

2 files changed

+118
-1
lines changed
+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"projectName": "serverless-runtime-types",
3+
"projectOwner": "twilio-labs",
4+
"repoType": "github",
5+
"repoHost": "https://github.com",
6+
"files": [
7+
"README.md"
8+
],
9+
"imageSize": 100,
10+
"commit": true,
11+
"commitConvention": "angular",
12+
"contributors": [
13+
{
14+
"login": "dkundel",
15+
"name": "Dominik Kundel",
16+
"avatar_url": "https://avatars3.githubusercontent.com/u/1505101?v=4",
17+
"profile": "https://dkundel.com",
18+
"contributions": [
19+
"code",
20+
"doc"
21+
]
22+
}
23+
],
24+
"contributorsPerLine": 7
25+
}

Diff for: packages/serverless-runtime-types/README.md

+93-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,93 @@
1-
# twilio-runtime-types
1+
<h1 align="center">@twilio-labs/serverless-runtime-types</h1>
2+
<p align="center">A module to interact with the <a href="https://www.twilio.com/functions">Twilio Serverless</a> API. For example to deploy projects. <br>Full reference documentation at <a href="https://serverless-api.twilio-labs.com">serverless-api.twilio-labs.com</a></p>
3+
<p align="center">
4+
<img alt="npm (scoped)" src="https://img.shields.io/npm/v/@twilio-labs/serverless-api.svg?style=flat-square"> <img alt="npm" src="https://img.shields.io/npm/dt/@twilio-labs/serverless-api.svg?style=flat-square"> <img alt="GitHub" src="https://img.shields.io/github/license/twilio-labs/serverless-api.svg?style=flat-square"> <a href="#contributors"><img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square" /></a> <a href="https://github.com/twilio-labs/.github/blob/master/CODE_OF_CONDUCT.md"><img alt="Code of Conduct" src="https://img.shields.io/badge/%F0%9F%92%96-Code%20of%20Conduct-blueviolet.svg?style=flat-square"></a> <a href="http://makeapullrequest.com"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome" /></a> </<a>
5+
<hr>
6+
7+
- [⚠️ **IMPORTANT**](#%E2%9A%A0%EF%B8%8F-IMPORTANT)
8+
- [Installation](#Installation)
9+
- [Example](#Example)
10+
- [API](#API)
11+
- [`client.activateBuild(activateConfig: ActivateConfig): Promise<ActivateResult>`](#clientactivateBuildactivateConfig-ActivateConfig-PromiseActivateResult)
12+
- [`client.deployLocalProject(deployConfig: DeployLocalProjectConfig): Promise<DeployResult>`](#clientdeployLocalProjectdeployConfig-DeployLocalProjectConfig-PromiseDeployResult)
13+
- [`client.deployProject(deployConfig: DeployProjectConfig): Promise<DeployResult>`](#clientdeployProjectdeployConfig-DeployProjectConfig-PromiseDeployResult)
14+
- [`client.getClient(): GotClient`](#clientgetClient-GotClient)
15+
- [`client.list(listConfig: ListConfig): Promise<ListResult>`](#clientlistlistConfig-ListConfig-PromiseListResult)
16+
- [`api` and `fsHelpers`](#api-and-fsHelpers)
17+
- [Contributing](#Contributing)
18+
- [Code of Conduct](#Code-of-Conduct)
19+
- [Contributors](#Contributors)
20+
- [License](#License)
21+
22+
## Installation
23+
24+
```bash
25+
npm install @twilio-labs/serverless-runtime-types
26+
```
27+
28+
## Example
29+
30+
If you want to deploy a local project you can do this using:
31+
32+
```js
33+
const TwilioServerlessApiClient = require('@twilio-labs/serverless-api');
34+
35+
const client = new TwilioServerlessApiClient({
36+
accountSid: '...',
37+
authToken: '...'
38+
});
39+
40+
client.on('status-update', evt => {
41+
console.log(evt.message);
42+
});
43+
44+
const result = await client.deployLocalProject({
45+
cwd: '...',
46+
envPath: '...',
47+
accountSid: '...',
48+
authToken: '...',
49+
env: { },
50+
pkgJson: {},
51+
projectName: 'serverless-example',
52+
functionsEnv: 'dev',
53+
assetsFolderName: 'static',
54+
functionsFolderName: 'src'
55+
});
56+
```
57+
58+
## Contributing
59+
60+
This project welcomes contributions from the community. Please see the [`CONTRIBUTING.md`](https://github.com/twilio-labs/.github/blob/master/CONTRIBUTING.md) file for more details.
61+
62+
### Code of Conduct
63+
64+
Please be aware that this project has a [Code of Conduct](https://github.com/twilio-labs/.github/blob/master/CODE_OF_CONDUCT.md). The tldr; is to just be excellent to each other ❤️
65+
66+
### Contributors
67+
68+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
69+
70+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
71+
<!-- prettier-ignore -->
72+
<table>
73+
<tr>
74+
<td align="center"><a href="https://dkundel.com"><img src="https://avatars3.githubusercontent.com/u/1505101?v=4" width="100px;" alt="Dominik Kundel"/><br /><sub><b>Dominik Kundel</b></sub></a><br /><a href="https://github.com/twilio-labs/serverless-runtime-types/commits?author=dkundel" title="Code">💻</a> <a href="https://github.com/twilio-labs/serverless-runtime-types/commits?author=dkundel" title="Documentation">📖</a></td>
75+
</tr>
76+
</table>
77+
78+
<!-- ALL-CONTRIBUTORS-LIST:END -->
79+
80+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
81+
82+
## License
83+
84+
MIT
85+
## Contributors ✨
86+
87+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
88+
89+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
90+
<!-- prettier-ignore -->
91+
<!-- ALL-CONTRIBUTORS-LIST:END -->
92+
93+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)