From 4a760ad32477f156e95ca699b46afaf08b2c8b3d Mon Sep 17 00:00:00 2001 From: Sergey Lyubka Date: Sat, 25 Aug 2012 22:48:14 +0100 Subject: [PATCH] Initial version of readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..8d99499d --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +Overview +-------- + +Mongoose is easy to use web server. It also can be used as embedded web server library to provide web interface to applications. + +Mongoose executable does not depend on any external library or configuration. If it is copied to any directory and launched from there, it starts to serve that directory on port 8080 (so to access files, go to http://localhost:8080). If some additional config is required - for example, different listening port or IP-based access control, then a mongoose.conf file with respective options can be created in the same directory where executable lives. This makes Mongoose perfect for all sorts of demos, quick tests, file sharing, and Web programming. + + +Features +-------- + +- Crossplatform - works on Windows, MacOS and most flavors of UNIX +- CGI, SSL, SSI, Digest (MD5) authorization, resumed download, aliases +- IP-based ACL, Windows service, GET, POST, HEAD, PUT, DELETE methods +- Small footprint: executable size is 40 kB on Linux 2.6 i386 system +- Embeddable with [simple and clean API](https://github.com/valenok/mongoose/blob/master/mongoose.h). Source is in single .c file to make things easy. Minimalistic embedding example is in [hello.c](https://github.com/valenok/mongoose/blob/master/examples/hello.c). +- Python and C# bindings + + +Mailing list +------------ + +You can read it online, subscribe to, or send a message at [mongoose-users](http://groups.google.com/group/mongoose-users). + + +Keep Sergey happy +----------------- + +I have a [books wishlist](http://amzn.com/w/1OC2ZCPTQYIEP?sort=priority) on Amazon. If you feel brave, you can buy me a book!