Skip to content

Commit 7c57b11

Browse files
authored
docs: improve README and add contributing guide (#44)
1 parent 426dcc6 commit 7c57b11

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
Thank you for considering contributing to **0http**!
4+
5+
## Development setup
6+
7+
1. Fork this repository and create a feature branch.
8+
2. Install dependencies:
9+
10+
```bash
11+
npm install
12+
```
13+
14+
3. Run the test suite:
15+
16+
```bash
17+
npm test
18+
```
19+
20+
4. Format the codebase before submitting your pull request:
21+
22+
```bash
23+
npm run format
24+
```
25+
26+
Feel free to open an issue or pull request if you have suggestions or fixes.

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,18 @@ Zero friction HTTP framework:
1111
- Tweaked Node.js HTTP server for high throughput.
1212
- High-performance and customizable request routers.
1313

14-
![Performance Benchmarks](docs/Benchmarks.png)
14+
![Performance Benchmarks](docs/Benchmarks.png)
1515

1616
> Check it yourself: https://web-frameworks-benchmark.netlify.app/result?f=feathersjs,0http,koa,fastify,nestjs-express,express,sails,nestjs-fastify,restana
1717
18+
## Installation
19+
20+
Install the package from npm:
21+
22+
```bash
23+
npm install 0http
24+
```
25+
1826
## Usage
1927
```js
2028
const cero = require('0http')
@@ -41,4 +49,4 @@ You can support the maintenance of this project:
4149
- [TRON](https://www.binance.com/en/buy-TRON) Wallet: `TJ5Bbf9v4kpptnRsePXYDvnYcYrS5Tyxus`
4250

4351
# More
44-
- Website and documentation: https://0http.21no.de
52+
- Website and documentation: https://0http.21no.de

0 commit comments

Comments
 (0)