UNPKG

3.3 kBMarkdownView Raw
1<div align="center">
2 <h1>Middy Core</h1>
3 <img alt="Middy logo" src="https://raw.githubusercontent.com/middyjs/middy/main/docs/img/middy-logo.svg"/>
4 <p><strong>Core component of the middy framework, the stylish Node.js middleware engine for AWS Lambda</strong></p>
5<p>
6 <a href="https://www.npmjs.com/package/@middy/core?activeTab=versions">
7 <img src="https://badge.fury.io/js/%40middy%2Fcore.svg" alt="npm version" style="max-width:100%;">
8 </a>
9 <a href="https://packagephobia.com/result?p=@middy/core">
10 <img src="https://packagephobia.com/badge?p=@middy/core" alt="npm install size" style="max-width:100%;">
11 </a>
12 <a href="https://github.com/middyjs/middy/actions/workflows/tests.yml">
13 <img src="https://github.com/middyjs/middy/actions/workflows/tests.yml/badge.svg?branch=main&event=push" alt="GitHub Actions CI status badge" style="max-width:100%;">
14 </a>
15 <br/>
16 <a href="https://standardjs.com/">
17 <img src="https://img.shields.io/badge/code_style-standard-brightgreen.svg" alt="Standard Code Style" style="max-width:100%;">
18 </a>
19 <a href="https://snyk.io/test/github/middyjs/middy">
20 <img src="https://snyk.io/test/github/middyjs/middy/badge.svg" alt="Known Vulnerabilities" data-canonical-src="https://snyk.io/test/github/middyjs/middy" style="max-width:100%;">
21 </a>
22 <a href="https://lgtm.com/projects/g/middyjs/middy/context:javascript">
23 <img src="https://img.shields.io/lgtm/grade/javascript/g/middyjs/middy.svg?logo=lgtm&logoWidth=18" alt="Language grade: JavaScript" style="max-width:100%;">
24 </a>
25 <a href="https://bestpractices.coreinfrastructure.org/projects/5280">
26 <img src="https://bestpractices.coreinfrastructure.org/projects/5280/badge" alt="Core Infrastructure Initiative (CII) Best Practices" style="max-width:100%;">
27 </a>
28 <br/>
29 <a href="https://gitter.im/middyjs/Lobby">
30 <img src="https://badges.gitter.im/gitterHQ/gitter.svg" alt="Chat on Gitter" style="max-width:100%;">
31 </a>
32 <a href="https://stackoverflow.com/questions/tagged/middy?sort=Newest&uqlId=35052">
33 <img src="https://img.shields.io/badge/StackOverflow-[middy]-yellow" alt="Ask questions on StackOverflow" style="max-width:100%;">
34 </a>
35</p>
36<p>You can read the documentation at: <a href="https://middy.js.org">https://middy.js.org</a></p>
37</div>
38
39
40## Install
41
42To install middy you can use NPM:
43
44```bash
45npm install --save @middy/core
46```
47
48
49## Documentation and examples
50
51For documentation and examples, refers to the main [Middy monorepo on GitHub](https://github.com/middyjs/middy) or [Middy official website](https://middy.js.org).
52
53
54## Contributing
55
56Everyone is very welcome to contribute to this repository. Feel free to [raise issues](https://github.com/middyjs/middy/issues) or to [submit Pull Requests](https://github.com/middyjs/middy/pulls).
57
58
59## License
60
61Licensed under [MIT License](LICENSE). Copyright (c) 2017-2022 [Luciano Mammino](https://github.com/lmammino), [will Farrell](https://github.com/willfarrell), and the [Middy team](https://github.com/middyjs/middy/graphs/contributors).
62
63<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy?ref=badge_large">
64 <img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmiddyjs%2Fmiddy.svg?type=large" alt="FOSSA Status" style="max-width:100%;">
65</a>