Skip to content

Commit 3c1246c

Browse files
committed
edited the README.md
1 parent b34fda3 commit 3c1246c

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ HTTPSify <small>v3</small>
22
=============================
33
A `Let'sEncrypt` based reverse proxy, that will automatically generate &amp; renew valid `ssl` certs for your domains, it also enables the `http/2` protocol by default, and uses `roundrobin` as an algorithm to loadbalance the incoming requests between multiple `upstreams`
44

5-
# Install
5+
# Quick Start
66

77
### # Using Docker
88
> Just run the following and then have fun !!
@@ -16,7 +16,7 @@ $ docker run -v $HOME:/root/ -p 443:443 alash3al/httpsify
1616
$ go get -u github.com/alash3al/httpsify
1717
```
1818

19-
### Configurations
19+
### # Configurations
2020
> Goto your `$HOME` Directory and edit the `hosts.json` to something like this
2121
```json
2222
{
@@ -29,3 +29,28 @@ and yes, it can loadbalance the requests between multiple upstreams using `round
2929

3030
> Also You don't need to restart the server to reload the configurations, because `httpsify` automatically watches the
3131
configurations file and reload it on any change.
32+
33+
# Author
34+
Mohammed Al Ashaal, a `gopher` and problem solver, see more projects by me [here](https://github.com/alash3al).
35+
36+
# License
37+
> The MIT License (MIT)
38+
39+
> Copyright (c) 2016 Mohammed Al Ashaal
40+
41+
> Permission is hereby granted, free of charge, to any person obtaining a copy
42+
of this software and associated documentation files (the "Software"), to deal
43+
in the Software without restriction, including without limitation the rights
44+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
45+
copies of the Software, and to permit persons to whom the Software is
46+
furnished to do so, subject to the following conditions:
47+
48+
> The above copyright notice and this permission notice shall be included in all
49+
copies or substantial portions of the Software.
50+
51+
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
52+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
53+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
54+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
55+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
56+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

0 commit comments

Comments
 (0)