update readme.
This commit is contained in:
parent
178a5973d0
commit
c3b74da561
2 changed files with 29 additions and 14 deletions
26
README
26
README
|
@ -1,17 +1,15 @@
|
||||||
herb
|
# herb
|
||||||
---------
|
herb is a web server written in Rust which focuses on using minimal dependencies and ease of use. It began as a hobby project to create a basic web server and has since been expanded.
|
||||||
T(h)e hackabl(e) web se(r)ver (b)inary (Formerly the web server yer mom uses.)
|
|
||||||
|
|
||||||
In all seriousness!
|
herb is able to send all types of data to clients, including text, video, audio, and images. It also supports dynamic webpages through CGI.
|
||||||
------------------------
|
|
||||||
This was a little fun experiment for me to mess around with Rust but at this point it has turned into a hobby server that I whittle away at.
|
|
||||||
|
|
||||||
At this point, if it's put behind a reverse proxy like HAProxy or nginx, it could actually be used as a small web server.
|
## Features
|
||||||
|
* Dynamic websites through CGI
|
||||||
|
* Only one external dependency (packeteer)
|
||||||
|
* Directory index generation
|
||||||
|
* Primitive media type detection
|
||||||
|
* Supports text and raw data, including PNGs and MP3s
|
||||||
|
* Installable with curze
|
||||||
|
|
||||||
To-do list
|
## Licensing
|
||||||
---------------
|
herb is licensed under [GNU General Public License version 3.](https://git.colean.cc/threeoh6000/herb/src/branch/master/LICENSE)
|
||||||
Custom error pages
|
|
||||||
Make it user configurable
|
|
||||||
Properly generate headers
|
|
||||||
Image thumbnailing/compression
|
|
||||||
Compressing big files
|
|
||||||
|
|
17
README.old
Normal file
17
README.old
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
herb
|
||||||
|
---------
|
||||||
|
T(h)e hackabl(e) web se(r)ver (b)inary (Formerly the web server yer mom uses.)
|
||||||
|
|
||||||
|
In all seriousness!
|
||||||
|
------------------------
|
||||||
|
This was a little fun experiment for me to mess around with Rust but at this point it has turned into a hobby server that I whittle away at.
|
||||||
|
|
||||||
|
At this point, if it's put behind a reverse proxy like HAProxy or nginx, it could actually be used as a small web server.
|
||||||
|
|
||||||
|
To-do list
|
||||||
|
---------------
|
||||||
|
Custom error pages
|
||||||
|
Make it user configurable
|
||||||
|
Properly generate headers
|
||||||
|
Image thumbnailing/compression
|
||||||
|
Compressing big files
|
Loading…
Reference in a new issue