Skip to content

Commit 0dac61f

Browse files
committed
docs(README): update readme file
1 parent 11b8b79 commit 0dac61f

File tree

1 file changed

+15
-38
lines changed

1 file changed

+15
-38
lines changed

README.md

Lines changed: 15 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,25 @@
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/http-server
42

53
<br />
64

7-
<div align="center">
8-
<h3>AdonisJS HTTP Server</h3>
9-
<p>A fully featured HTTP server with first class support for <strong>Route groups</strong>, <strong>Sub-domain routing</strong>, <strong>Middleware</strong> and <strong>Cookies</strong>.</p>
10-
</div>
5+
[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]
116

12-
<br />
7+
## Introduction
8+
Implementation of HTTP server used by AdonisJS. The package ships with a powerful **Router**, **Middleware pipeline**, helpers to create plain and signed URL for registered routes and much more.
139

14-
<div align="center">
10+
## Official Documentation
11+
The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/context)
1512

16-
[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![synk-image]][synk-url]
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.
17+
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).
1720

18-
</div>
19-
20-
<div align="center">
21-
<h3>
22-
<a href="https://adonisjs.com">
23-
Website
24-
</a>
25-
<span> | </span>
26-
<a href="https://docs.adonisjs.com/guides/context">
27-
Guides
28-
</a>
29-
<span> | </span>
30-
<a href="CONTRIBUTING.md">
31-
Contributing
32-
</a>
33-
<span> | </span>
34-
<a href="benchmarks.md">
35-
Benchmarks
36-
</a>
37-
</h3>
38-
</div>
39-
40-
<div align="center">
41-
<sub>Built with ❤︎ by <a href="https://twitter.com/AmanVirk1">Harminder Virk</a>
42-
</div>
43-
44-
[appveyor-image]: https://img.shields.io/appveyor/ci/thetutlage/http-server/master.svg?style=for-the-badge&logo=appveyor
45-
[appveyor-url]: https://ci.appveyor.com/project/thetutlage/http-server "appveyor"
21+
## License
22+
AdonisJS HTTP server is open-sourced software licensed under the [MIT license](LICENSE.md).
4623

4724
[gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/http-server/test?style=for-the-badge
4825
[gh-workflow-url]: https://github.com/adonisjs/http-server/actions/workflows/test.yml "Github action"

0 commit comments

Comments
 (0)