Update README

Signed-off-by: Jianhui Zhao <jianhuizhao329@gmail.com>
main
Jianhui Zhao 2017-11-10 19:16:47 +08:00
parent fbbea9df30
commit 3cf9c4cf8d
3 changed files with 64 additions and 1 deletions

42
CONTRIBUTING.md 100755
View File

@ -0,0 +1,42 @@
Contributing
================================================================================
If you want to contribute to [libuhttp](https://github.com/zhaojh329/libuhttp), please follow these simple rules:
1. Press the fork button:
![fork](http://oi58.tinypic.com/jj2trm.jpg)
2. Clone the repository from your account with:
```
git clone git@github.com:your_github_username/libuhttp.git
```
3. Create a new branch with:
```
git checkout -b "libuhttp-1-fix"
```
You can name it however you want.
4. Make your changes
5. Don't forget to add yourself in `CONTRIBUTORS.md`.
6. Commit and push your changes, then make a pull request from Github.
git commit --signoff
git push
7. Awaiting review, if accepted, merged!
**IMPORTANT**
Please, don't forget to update your fork. While you made your changes,
the content of the `master` branch can change because other pull requests
were merged and it can create conflicts. This is why you have to rebase
on `master` every time before pushing your changes and check that your
branch doesn't have any conflicts with `master`.
Thank you.

3
CONTRIBUTORS.md 100755
View File

@ -0,0 +1,3 @@
Thank you to all contributors:
------------------------------
[Jianhui Zhao](https://github.com/zhaojh329)

View File

@ -5,6 +5,11 @@
A very tiny and fast HTTP library based on [libev](http://software.schmorp.de/pkg/libev.html) and
[http-parser](https://github.com/nodejs/http-parser) for Embedded Linux.
# Features
* Tiny and fast
* SSL support: Optional OpenSSL and CyaSSl(wolfssl)
* Highly customizable, and can be easily integrated into your application
# How To Compile on Ubuntu
## Install dependency Tools and Libraries
sudo apt install cmake libev-dev libhttp-parser-dev
@ -20,4 +25,17 @@ A very tiny and fast HTTP library based on [libev](http://software.schmorp.de/pk
## Test
$ ./example/helloworld
Then use the command curl or browser to access http://127.0.0.1:8000/test
Then use the command curl or browser to access https://127.0.0.1:8000/test
$ curl -k https://127.0.0.1:8000/test -v
# [Example](https://github.com/zhaojh329/libuhttp/blob/master/example/helloworld.c)
# Contributing
If you would like to help making libuhttp better, see the [CONTRIBUTING.md](https://github.com/zhaojh329/libuhttp/blob/master/CONTRIBUTING.md) file.
# Thanks for the following project
* [libev](http://software.schmorp.de/pkg/libev.html)
* [http-parser](https://github.com/nodejs/http-parser)
# If the project is helpful to you, please do not hesitate to star. Thank you!