mongoose/README.md

Project Mission
---------------

Project mission is to provide simple, functional, embeddable web server to
make it easy for application and device developers to implement web interface for their
application and devices, and to offer a simple web development environment.

Overview
--------

To accomplish it's mission, Mongoose keeps balance on functionality and
simplicity by carefully selected list of features:

- Liberal, commercial-friendly [MIT license](http://en.wikipedia.org/wiki/MIT_License)
- Works on Windows, Mac, UNIX, iPhone, Android, and many other platforms
- Support for CGI, SSL, SSI, Digest (MD5) authorization, Websocket, WEbDAV
- Lua server pages (PHP-like functionality using Lua), see [page.lp](https://github.com/valenok/mongoose/blob/master/test/page.lp)
- Resumed download, URL rewrite, IP-based ACL, Windows service
- Excluding files from serving by URI pattern (file blacklist)
- Download speed limit based on client subnet or URI pattern
- Small footprint: executable size is 50 kB on Linux 2.6 i386 system
- 130 kilobytes Windows executable with all of the above and no dependencies
- Simple and clean embedding API ([mongoose.h](https://github.com/valenok/mongoose/blob/master/mongoose.h)). The source is in single [mongoose.c](https://github.com/valenok/mongoose/blob/master/mongoose.c) file to make things easy.
- Embedding examples: [hello.c](https://github.com/valenok/mongoose/blob/master/examples/hello.c), [post.c](https://github.com/valenok/mongoose/blob/master/examples/post.c), [upload.c](https://github.com/valenok/mongoose/blob/master/examples/upload.c), [websocket.c](https://github.com/valenok/mongoose/blob/master/examples/websocket.c)
- Extensive documentation in form of [User Manual](https://github.com/valenok/mongoose/blob/master/UserManual.md)

Questions can be asked at
[mongoose-users@google.com](http://groups.google.com/group/mongoose-users) mailing list.


Keep Sergey happy
-----------------

Since 2004, Mongoose is being constantly improved by me, Sergey Lyubka, a software engineer
from Galway, Ireland. My other software I give to the community for free is
[Super Light Regular Expression library](http://code.google.com/p/slre).


If you feel grateful for the stuff I've done, you can buy me a book from my
[Amazon wishlist](http://amzn.com/w/1OC2ZCPTQYIEP?sort=priority). Many thanks
to all who already did so: T.Barmann, D.Hughes, J.C.Sloan, R.Romeo,
L.E.Spencer, and 4 others. Appreciated guys, you keep my brains going!
Mission statement 2013-01-01 23:05:09 +00:00			`Project Mission`
			`---------------`
Initial version of readme 2012-08-25 22:48:14 +01:00
Update README.md 2013-01-02 13:32:07 +00:00			`Project mission is to provide simple, functional, embeddable web server to`
			`make it easy for application and device developers to implement web interface for their`
Update README.md 2013-01-04 21:25:58 +00:00			`application and devices, and to offer a simple web development environment.`
Mission statement 2013-01-01 23:05:09 +00:00
			`Overview`
Initial version of readme 2012-08-25 22:48:14 +01:00			`--------`

Mission statement 2013-01-01 23:05:09 +00:00			`To accomplish it's mission, Mongoose keeps balance on functionality and`
			`simplicity by carefully selected list of features:`

Update README.md 2013-01-02 13:35:30 +00:00			`- Liberal, commercial-friendly [MIT license](http://en.wikipedia.org/wiki/MIT_License)`
Update README.md 2013-01-02 13:48:40 +00:00			`- Works on Windows, Mac, UNIX, iPhone, Android, and many other platforms`
			`- Support for CGI, SSL, SSI, Digest (MD5) authorization, Websocket, WEbDAV`
			`- Lua server pages (PHP-like functionality using Lua), see [page.lp](https://github.com/valenok/mongoose/blob/master/test/page.lp)`
Update README.md 2012-12-24 14:09:48 +00:00			`- Resumed download, URL rewrite, IP-based ACL, Windows service`
			`- Excluding files from serving by URI pattern (file blacklist)`
Added more things to features section 2012-09-23 15:06:09 +01:00			`- Download speed limit based on client subnet or URI pattern`
Update README.md 2012-12-24 14:09:48 +00:00			`- Small footprint: executable size is 50 kB on Linux 2.6 i386 system`
Mission statement 2013-01-01 23:05:09 +00:00			`- 130 kilobytes Windows executable with all of the above and no dependencies`
Update README.md 2013-01-02 13:48:40 +00:00			`- Simple and clean embedding API ([mongoose.h](https://github.com/valenok/mongoose/blob/master/mongoose.h)). The source is in single [mongoose.c](https://github.com/valenok/mongoose/blob/master/mongoose.c) file to make things easy.`
Cosmetic changes 2012-09-20 14:17:28 +01:00			`- Embedding examples: [hello.c](https://github.com/valenok/mongoose/blob/master/examples/hello.c), [post.c](https://github.com/valenok/mongoose/blob/master/examples/post.c), [upload.c](https://github.com/valenok/mongoose/blob/master/examples/upload.c), [websocket.c](https://github.com/valenok/mongoose/blob/master/examples/websocket.c)`
Correctedfor UserManual 2013-01-03 22:39:48 +00:00			`- Extensive documentation in form of [User Manual](https://github.com/valenok/mongoose/blob/master/UserManual.md)`
Mission statement 2013-01-01 23:05:09 +00:00
Update README.md 2013-01-02 13:48:40 +00:00			`Questions can be asked at`
			`[mongoose-users@google.com](http://groups.google.com/group/mongoose-users) mailing list.`
Initial version of readme 2012-08-25 22:48:14 +01:00

			`Keep Sergey happy`
			`-----------------`

Update README.md 2013-01-02 14:06:28 +00:00			`Since 2004, Mongoose is being constantly improved by me, Sergey Lyubka, a software engineer`
			`from Galway, Ireland. My other software I give to the community for free is`
			`[Super Light Regular Expression library](http://code.google.com/p/slre).`
Update README.md 2013-01-02 13:50:27 +00:00

			`If you feel grateful for the stuff I've done, you can buy me a book from my`
Changed README 2013-01-17 10:59:42 +00:00			`[Amazon wishlist](http://amzn.com/w/1OC2ZCPTQYIEP?sort=priority). Many thanks`
			`to all who already did so: T.Barmann, D.Hughes, J.C.Sloan, R.Romeo,`
			`L.E.Spencer, and 4 others. Appreciated guys, you keep my brains going!`