Skip to content

Commit

Permalink
docs(README): update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Dec 23, 2019
1 parent 2a97c22 commit d9bbcad
Showing 1 changed file with 52 additions and 12 deletions.
64 changes: 52 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,64 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of contents

- [ Set of core commands for building AdonisJS projects ](#set-of-core-commands-for-building-adonisjs-projects)
- [

Website

|

Guides

|

Contributing

](#website%0A----%0A------%0A----%0A------guides%0A----%0A------%0A----%0A------contributing)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

<div align="center">
<img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px">
</div>

# Adonis Assembler
> A set of core commands to compile and serve AdonisJS applications
<br />

[![circleci-image]][circleci-url] [![npm-image]][npm-url]
<div align="center">
<h3> Set of core commands for building AdonisJS projects </h3>
<p>
Assembler contains a set of core commands to <strong>build and serve the AdonisJS typescript project</strong>, along with scaffolding <code>make</code> commands.
</p>
</div>

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of contents
<br />

- [@adonisjs/assembler](#adonisjsassembler)
- [Change log](#change-log)
- [Contributing](#contributing)
- [Authors & License](#authors--license)
<div align="center">

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
[![circleci-image]][circleci-url] [![npm-image]][npm-url]

</div>

The assembler exposes a set of commands to build and serve AdonisJS applications. Docs will follow soon.
<div align="center">
<h3>
<a href="https://adonisjs.com">
Website
</a>
<span> | </span>
<a href="https://adonisjs.com/docs">
Guides
</a>
<span> | </span>
<a href="CONTRIBUTING.md">
Contributing
</a>
</h3>
</div>

<div align="center">
<sub>Built with ❤︎ by <a href="https://github.com/thetutlage">Harminder Virk</a>
</div>

[circleci-image]: https://img.shields.io/circleci/project/github/adonisjs/assembler/master.svg?style=for-the-badge&logo=circleci
[circleci-url]: https://circleci.com/gh/adonisjs/aseembler "circleci"
Expand Down

0 comments on commit d9bbcad

Please sign in to comment.