Skip to content

Commit 35c49d8

Browse files
committed
docs: update readme contents and layout
1 parent 01689a7 commit 35c49d8

File tree

1 file changed

+51
-24
lines changed

1 file changed

+51
-24
lines changed

README.md

+51-24
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,70 @@
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>
4-
5-
# Adonis Core
6-
7-
> The core of the framework to run AdonisJs applications
8-
9-
[![circleci-image]][circleci-url]
10-
[![npm-image]][npm-url]
11-
![typescript-image](https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript)
12-
131
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
142
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
153
## Table of contents
164

17-
- [Change log](#change-log)
18-
- [Contributing](#contributing)
19-
- [Authors & License](#authors--license)
5+
- [Fullstack MVC framework for Node.js](#fullstack-mvc-framework-for-nodejs)
6+
- [
7+
8+
Website
9+
10+
|
11+
12+
Guides
13+
14+
|
15+
16+
Contributing
17+
18+
](#website%0A----%0A------%0A----%0A------guides%0A----%0A------%0A----%0A------contributing)
2019

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

23-
## Change log
22+
<div align="center">
23+
<img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px">
24+
</div>
25+
26+
<br />
2427

25-
The change log can be found in the [CHANGELOG.md](CHANGELOG.md) file.
28+
<div align="center">
29+
<h3>Fullstack MVC framework for Node.js</h3>
30+
<p>AdonisJs is a fullstack Web framework with focus on <strong> ergonomics and speed </strong>. It takes care of much of the Web development hassles, offering you a clean and stable API to build Web apps and micro services.</p>
31+
</div>
2632

27-
## Contributing
33+
<br />
2834

29-
Everyone is welcome to contribute. Please go through the following guides, before getting started.
35+
<div align="center">
3036

31-
1. [Contributing](https://adonisjs.com/contributing)
32-
2. [Code of conduct](https://adonisjs.com/code-of-conduct)
37+
[![circleci-image]][circleci-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]
3338

34-
## Authors & License
39+
</div>
3540

36-
[Harminder virk](https://github.com/thetutlage) and [contributors](https://github.com/adonisjs/adonis-framework/graphs/contributors).
41+
<div align="center">
42+
<h3>
43+
<a href="https://adonisjs.com">
44+
Website
45+
</a>
46+
<span> | </span>
47+
<a href="https://adonisjs.com/docs">
48+
Guides
49+
</a>
50+
<span> | </span>
51+
<a href=".github/CONTRIBUTING.md">
52+
Contributing
53+
</a>
54+
</h3>
55+
</div>
3756

38-
MIT License, see the included [MIT](LICENSE.md) file.
57+
<div align="center">
58+
<sub>Built with ❤︎ by <a href="https://github.com/thetutlage">Harminder Virk</a>
59+
</div>
3960

4061
[circleci-image]: https://img.shields.io/circleci/project/github/adonisjs/adonis-framework/master.svg?style=for-the-badge&logo=circleci
4162
[circleci-url]: https://circleci.com/gh/adonisjs/adonis-framework "circleci"
63+
4264
[npm-image]: https://img.shields.io/npm/v/@adonisjs/core.svg?style=for-the-badge&logo=npm
4365
[npm-url]: https://npmjs.org/package/@adonisjs/core "npm"
66+
67+
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
68+
69+
[license-url]: LICENSE.md
70+
[license-image]: https://img.shields.io/aur/license/pac.svg?style=for-the-badge

0 commit comments

Comments
 (0)