|
1 |
| -<div align="center"> |
2 |
| - <img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px"> |
3 |
| -</div> |
| 1 | +# @adonisjs/assembler |
4 | 2 |
|
5 | 3 | <br />
|
6 | 4 |
|
7 |
| -<div align="center"> |
8 |
| - <h3> Core Commands for building AdonisJS projects </h3> |
9 |
| - <p> |
10 |
| - Assembler contains a set of core commands to <strong>build and serve the AdonisJS typescript project</strong>, along with scaffolding <code>make</code> commands. |
11 |
| - </p> |
12 |
| -</div> |
| 5 | +[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url] |
13 | 6 |
|
14 |
| -<br /> |
| 7 | +## Introduction |
| 8 | +Assembler exports the API for starting the **AdonisJS development server**, **building project for production** and **running tests** in watch mode. Assembler must be used during development only. |
| 9 | + |
| 10 | +## Official Documentation |
| 11 | +The documentation is available on the official website |
| 12 | + |
| 13 | +## Contributing |
| 14 | +One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework. |
| 15 | + |
| 16 | +We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework. |
15 | 17 |
|
16 |
| -<div align="center"> |
17 |
| - |
18 |
| -[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] [![synk-image]][synk-url] |
19 |
| - |
20 |
| -</div> |
21 |
| - |
22 |
| -<div align="center"> |
23 |
| - <h3> |
24 |
| - <a href="https://adonisjs.com"> |
25 |
| - Website |
26 |
| - </a> |
27 |
| - <span> | </span> |
28 |
| - <a href="https://docs.adonisjs.com/guides/installation"> |
29 |
| - Guides |
30 |
| - </a> |
31 |
| - <span> | </span> |
32 |
| - <a href="CONTRIBUTING.md"> |
33 |
| - Contributing |
34 |
| - </a> |
35 |
| - </h3> |
36 |
| -</div> |
37 |
| - |
38 |
| -<div align="center"> |
39 |
| - <sub>Built with ❤︎ by <a href="https://twitter.com/AmanVirk1">Harminder Virk</a> |
40 |
| -</div> |
41 |
| - |
42 |
| -[gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/assembler/test?style=for-the-badge |
| 18 | +## Code of Conduct |
| 19 | +In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md). |
| 20 | + |
| 21 | +## License |
| 22 | +AdonisJS Assembler is open-sourced software licensed under the [MIT license](LICENSE.md). |
| 23 | + |
| 24 | +[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/assembler/test.yml?style=for-the-badge |
43 | 25 | [gh-workflow-url]: https://github.com/adonisjs/assembler/actions/workflows/test.yml "Github action"
|
44 | 26 |
|
45 | 27 | [npm-image]: https://img.shields.io/npm/v/@adonisjs/assembler/latest.svg?style=for-the-badge&logo=npm
|
46 | 28 | [npm-url]: https://npmjs.org/package/@adonisjs/assembler/v/latest "npm"
|
47 | 29 |
|
| 30 | +[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript |
| 31 | + |
| 32 | +[license-url]: LICENSE.md |
| 33 | +[license-image]: https://img.shields.io/github/license/adonisjs/ace?style=for-the-badge |
| 34 | + |
48 | 35 | [synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/assembler?label=Synk%20Vulnerabilities&style=for-the-badge
|
49 | 36 | [synk-url]: https://snyk.io/test/github/adonisjs/assembler?targetFile=package.json "synk"
|
0 commit comments