view README.rst @ 17:2874f61a43b1

implementing the directory index generation
author John Tsiombikas <nuclear@member.fsf.org>
date Tue, 21 Apr 2015 04:33:02 +0300
parents a9ed0b2260ee
line source
1 tinyweb - tiny web server library and daemon
2 ============================================
4 The tinyweb project includes a rudimentary web server in library form
5 (libtinyweb), and a simple web server daemon (tinywebd) which uses it.
7 Author: John Tsiombikas <nuclear@member.fsf.org>
9 I disclaim all copyright to this program, and place it in the public domain.
10 Feel free to use it any way you like. Mentions and retaining the attribution
11 headers at the top of the source code would be appreciated, but not required.
13 Feel free to send me an email if you find a cool use for this code.
15 Download
16 --------
17 Latest release: no releases yet, just grab the source from the repo.
19 Code repository: https://github.com/jtsiomb/tinyweb
21 Usage
22 -----
23 See ``src/main.c`` as an example on how to use libtinyweb, and read the header
24 file ``libtinyweb/src/tinyweb.h`` which is very simple, and heavily commented.
26 It will serve everything under the current working directory. Default port is
27 8080.
29 Bugs
30 ----
31 Issues that I intend to fix or improve at some point:
33 - Only GET and HEAD HTTP requests are currently implemented.
34 - Doesn't support partial downloads.
35 - It's supposed to be cross platform, but it isn't yet (UNIX only).
37 Issues that are the way they are by design:
39 - Tinywebd is not really a daemon (doesn't release controlling terminal).
40 - Doesn't scale well to lots of simultaneous clients (to keep it simple).