Browse Source

Update README.md

Dialga 3 years ago
parent
commit
353a1b3e73
1 changed files with 40 additions and 57 deletions
  1. 40 57
      README.md

+ 40 - 57
README.md

@@ -1,10 +1,12 @@
-![CivetWeb](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/civetweb_64x64.png "CivetWeb") CivetWeb
+![CivetWeb](/resources/civetweb_64x64.png "CivetWeb") CivetWeb
 =======
 =======
 
 
-**The official home of CivetWeb is [https://github.com/civetweb/civetweb](https://github.com/civetweb/civetweb)**
+**The official home of CivetWeb is on GitHub [https://github.com/civetweb/civetweb](https://github.com/civetweb/civetweb)**
 
 
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 [![GitHub contributors](https://img.shields.io/github/contributors/civetweb/civetweb.svg)](https://github.com/civetweb/civetweb/blob/master/CREDITS.md)
 [![GitHub contributors](https://img.shields.io/github/contributors/civetweb/civetweb.svg)](https://github.com/civetweb/civetweb/blob/master/CREDITS.md)
+[![Stargazers](https://img.shields.io/github/stars/civetweb/civetweb.svg)](https://github.com/civetweb/civetweb/stargazers)
+[![Forks](https://img.shields.io/github/forks/civetweb/civetweb.svg)](https://github.com/civetweb/civetweb/network/members)
 
 
 Continuous integration for Linux and macOS ([Travis CI](https://app.travis-ci.com/github/civetweb/civetweb)):
 Continuous integration for Linux and macOS ([Travis CI](https://app.travis-ci.com/github/civetweb/civetweb)):
 
 
@@ -18,17 +20,13 @@ Test coverage check ([coveralls](https://coveralls.io/github/civetweb/civetweb),
 
 
 [![Coveralls](https://img.shields.io/coveralls/civetweb/civetweb.svg?maxAge=3600)]()
 [![Coveralls](https://img.shields.io/coveralls/civetweb/civetweb.svg?maxAge=3600)]()
 [![Coverage Status](https://coveralls.io/repos/github/civetweb/civetweb/badge.svg?branch=master)](https://coveralls.io/github/civetweb/civetweb?branch=master)
 [![Coverage Status](https://coveralls.io/repos/github/civetweb/civetweb/badge.svg?branch=master)](https://coveralls.io/github/civetweb/civetweb?branch=master)
-
 [![codecov](https://codecov.io/gh/civetweb/civetweb/branch/master/graph/badge.svg)](https://codecov.io/gh/civetweb/civetweb)
 [![codecov](https://codecov.io/gh/civetweb/civetweb/branch/master/graph/badge.svg)](https://codecov.io/gh/civetweb/civetweb)
 
 
-
-
 Static source code analysis ([Coverity](https://scan.coverity.com/projects/5784)):
 Static source code analysis ([Coverity](https://scan.coverity.com/projects/5784)):
 
 
 [![Coverity Scan Build Status](https://scan.coverity.com/projects/5784/badge.svg)](https://scan.coverity.com/projects/5784)
 [![Coverity Scan Build Status](https://scan.coverity.com/projects/5784/badge.svg)](https://scan.coverity.com/projects/5784)
 
 
 
 
-
 Project Mission
 Project Mission
 -----------------
 -----------------
 
 
@@ -43,7 +41,7 @@ It can also be used by end users as a stand-alone web server running on a Window
 Where to find the official version?
 Where to find the official version?
 -----------------------------------
 -----------------------------------
 
 
-End users can download CivetWeb binaries / releases from SourceForge
+End users can download CivetWeb binaries / releases from here on GitHub [https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases) or SourceForge
 [https://sourceforge.net/projects/civetweb/](https://sourceforge.net/projects/civetweb/)
 [https://sourceforge.net/projects/civetweb/](https://sourceforge.net/projects/civetweb/)
 
 
 Developers can contribute to CivetWeb via GitHub
 Developers can contribute to CivetWeb via GitHub
@@ -52,10 +50,10 @@ Developers can contribute to CivetWeb via GitHub
 Due to a [bug in Git for Windows V2.24](https://github.com/git-for-windows/git/issues/2435)
 Due to a [bug in Git for Windows V2.24](https://github.com/git-for-windows/git/issues/2435)
 CivetWeb must be used with an earlier or later version (see also [here](https://github.com/civetweb/civetweb/issues/812)).
 CivetWeb must be used with an earlier or later version (see also [here](https://github.com/civetweb/civetweb/issues/812)).
 
 
-Trouble tickets should be filed on GitHub
+Bugs and requests should be filed on GitHub
 [https://github.com/civetweb/civetweb/issues](https://github.com/civetweb/civetweb/issues)
 [https://github.com/civetweb/civetweb/issues](https://github.com/civetweb/civetweb/issues)
 
 
-New releases are announced at Google Groups
+New releases are announced on Google Groups
 [https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb)
 [https://groups.google.com/d/forum/civetweb](https://groups.google.com/d/forum/civetweb)
 
 
 Formerly some support question and discussion threads have been at [Google groups](https://groups.google.com/d/forum/civetweb).
 Formerly some support question and discussion threads have been at [Google groups](https://groups.google.com/d/forum/civetweb).
@@ -65,15 +63,7 @@ Source releases can be found on GitHub
 [https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases)
 [https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases)
 
 
 A very brief overview can be found on GitHub Pages
 A very brief overview can be found on GitHub Pages
-[http://civetweb.github.io/civetweb/](http://civetweb.github.io/civetweb/)
-
-
-Getting The Source
-------------------
-Download the source code by running the following code in your command prompt:
-
-$ git clone https://github.com/civetweb/civetweb.git
-or simply grab a copy of the source code as a ZIP or TGZ file.
+[https://civetweb.github.io/civetweb/](https://civetweb.github.io/civetweb/)
 
 
 
 
 Quick start documentation
 Quick start documentation
@@ -96,29 +86,29 @@ Overview
 CivetWeb keeps the balance between functionality and
 CivetWeb keeps the balance between functionality and
 simplicity by a carefully selected list of features:
 simplicity by a carefully selected list of features:
 
 
-- Liberal, commercial-friendly, permissive,
-  [MIT license](http://en.wikipedia.org/wiki/MIT_License)
-- Free from copy-left licenses, like GPL, because you should innovate without
-  restrictions.
 - Forked from [Mongoose](https://code.google.com/p/mongoose/) in 2013, before
 - Forked from [Mongoose](https://code.google.com/p/mongoose/) in 2013, before
   it changed the licence from MIT to commercial + GPL. A lot of enhancements
   it changed the licence from MIT to commercial + GPL. A lot of enhancements
-  have been added since that time, see
+  have been added since then, see
   [RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md).
   [RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md).
-- Works on Windows, Mac, Linux, UNIX, iPhone, Android, Buildroot, and many
+- Maintains the liberal, permissive, commercial-friendly,
+  [MIT license](https://en.wikipedia.org/wiki/MIT_License)
+- Project is free from copy-left licenses, like GPL, because you should innovate without
+  restrictions.
+- Works on Windows, Mac, Linux, UNIX, IOS, Android, Buildroot, and many
   other platforms.
   other platforms.
-- Scripting and database support (CGI, SQLite database, Lua Server Pages,
-  Server side Lua scripts, Server side JavaScript).
+- Scripting and database support (CGI, Lua Server Pages, Server side Lua scripts, Lua SQLite database,
+  Server side JavaScript).
   This provides a ready to go, powerful web development platform in a one
   This provides a ready to go, powerful web development platform in a one
-  single-click executable with **no dependencies**.0
-- Support for CGI, SSI, HTTP digest (MD5) authorization, WebSocket,
-  WebDAV.
+  single-click executable with **no dependencies**. 0
+- Support for CGI, SSI, HTTP digest (MD5) authorization, WebSocket, WebDAV.
+- Experimental HTTP/2 support.
 - HTTPS (SSL/TLS) support using [OpenSSL](https://www.openssl.org/).
 - HTTPS (SSL/TLS) support using [OpenSSL](https://www.openssl.org/).
 - Optional support for authentication using client side X.509 certificates.
 - Optional support for authentication using client side X.509 certificates.
 - Resumed download, URL rewrite, file blacklist, IP-based ACL.
 - Resumed download, URL rewrite, file blacklist, IP-based ACL.
-- May run as Windows service.
+- Can run as a Windows service or systemd service.
 - Download speed limit based on client subnet or URI pattern.
 - Download speed limit based on client subnet or URI pattern.
 - Simple and clean embedding API.
 - Simple and clean embedding API.
-- The source is in single file to make things easy.
+- The source is in single file for drop in compilation.
 - Embedding examples included.
 - Embedding examples included.
 - HTTP client capable of sending arbitrary HTTP/HTTPS requests.
 - HTTP client capable of sending arbitrary HTTP/HTTPS requests.
 - Websocket client functionality available (WS/WSS).
 - Websocket client functionality available (WS/WSS).
@@ -126,27 +116,21 @@ simplicity by a carefully selected list of features:
 
 
 ### Optionally included software
 ### Optionally included software
 
 
-[![Lua](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/lua-logo.jpg "Lua Logo")](http://lua.org)
+[![Lua](/resources/lua-logo.jpg "Lua Logo")](https://lua.org)
+[![LuaFileSystem](/resources/luafilesystem-logo.jpg "LuaFileSystem Logo")](https://keplerproject.github.io/luafilesystem/)
+[![LuaSQLite3](/resources/luasqlite-logo.jpg "LuaSQLite3 Logo")](https://lua.sqlite.org/index.cgi/index)
+[![Sqlite3](/resources/sqlite3-logo.jpg "Sqlite3 Logo")](https://sqlite.org)
+[![LuaXML](/resources/luaxml-logo.jpg "LuaXML Logo")](https://github.com/n1tehawk/LuaXML)
+[![Duktape](/resources/duktape-logo.png "Duktape Logo")](https://duktape.org)
 
 
-[![Sqlite3](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/sqlite3-logo.jpg "Sqlite3 Logo")](http://sqlite.org)
 
 
-[![LuaFileSystem](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luafilesystem-logo.jpg "LuaFileSystem Logo")](http://keplerproject.github.io/luafilesystem/)
+### Optional dependencies
 
 
-[![LuaSQLite3](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luasqlite-logo.jpg "LuaSQLite3 Logo")](http://lua.sqlite.org/index.cgi/index)
+[zlib](https://zlib.net)
 
 
-[![LuaXML](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luaxml-logo.jpg "LuaXML Logo")](https://github.com/n1tehawk/LuaXML)
-
-[![Duktape](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/duktape-logo.png "Duktape Logo")](http://duktape.org)
-
-
-### Optional depencencies
-
-[![zlib](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/zlib3d-b1.png "zlib Logo")](https://zlib.net)
-
-[![OpenSSL](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/OpenSSL_logo.png "OpenSSL Logo")](https://www.openssl.org/)
-
-[![Mbed TLS](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/mbedTLS_logo.png "mbedTLS Logo")](https://github.com/ARMmbed/mbedtls)
+[OpenSSL](https://www.openssl.org/)
 
 
+[Mbed TLS](https://github.com/ARMmbed/mbedtls)
 
 
 
 
 Support
 Support
@@ -169,14 +153,13 @@ Any link provided in this project (including source and documentation) is provid
 However, we cannot accept any responsibility for any content on an external page.
 However, we cannot accept any responsibility for any content on an external page.
 
 
 
 
-
 Contributions
 Contributions
 -------------
 -------------
 
 
 Contributions are welcome provided all contributions carry the MIT license.
 Contributions are welcome provided all contributions carry the MIT license.
 
 
 DO NOT APPLY fixes copied from Mongoose to this project to prevent GPL tainting.
 DO NOT APPLY fixes copied from Mongoose to this project to prevent GPL tainting.
-Since 2013, CivetWeb and Mongoose are developed independently.
+Since 2013, CivetWeb and Mongoose have been developed independently.
 By now the code base differs, so patches cannot be safely transferred in either direction.
 By now the code base differs, so patches cannot be safely transferred in either direction.
 
 
 Some guidelines can be found in [docs/Contribution.md](https://github.com/civetweb/civetweb/blob/master/docs/Contribution.md).
 Some guidelines can be found in [docs/Contribution.md](https://github.com/civetweb/civetweb/blob/master/docs/Contribution.md).
@@ -185,17 +168,18 @@ Some guidelines can be found in [docs/Contribution.md](https://github.com/civetw
 Authors
 Authors
 -------
 -------
 
 
-CivetWeb has been forked from the last MIT version of Mongoose in 2013.
+CivetWeb was forked from the last MIT version of Mongoose in August 2013.
 Since then, CivetWeb has seen many improvements from various authors
 Since then, CivetWeb has seen many improvements from various authors
 (Copyright (c) 2013-2021 the CivetWeb developers, MIT license).
 (Copyright (c) 2013-2021 the CivetWeb developers, MIT license).
 
 
 A list of authors can be found in [CREDITS.md](https://github.com/civetweb/civetweb/blob/master/CREDITS.md).
 A list of authors can be found in [CREDITS.md](https://github.com/civetweb/civetweb/blob/master/CREDITS.md).
 
 
-CivetWeb is based on the Mongoose project.  The original author of Mongoose was
-Sergey Lyubka (Copyright (c) 2004-2013 Sergey Lyubka, MIT license).
-However, on August 16, 2013, the [license of Mongoose has been changed](https://groups.google.com/forum/#!topic/mongoose-users/aafbOnHonkI)
-after writing and distributing the original code this project is based on.
-The license change and CivetWeb used to be mentioned on the Mongoose
+CivetWeb is based on the [Mongoose project](https://github.com/cesanta/mongoose). The original author of Mongoose was
+Sergey Lyubka(2004-2013) who released it under the MIT license.
+However, on August 16, 2013,
+[Mongoose was relicensed to a dual GPL V2 + commercial license](https://groups.google.com/forum/#!topic/mongoose-users/aafbOnHonkI)
+as the project grew and required more attention than a single developer could provide.
+The license change and CivetWeb fork was mentioned on the Mongoose
 [Wikipedia](https://en.wikipedia.org/wiki/Mongoose_(web_server))
 [Wikipedia](https://en.wikipedia.org/wiki/Mongoose_(web_server))
 page as well, but it's getting deleted (and added again) there every
 page as well, but it's getting deleted (and added again) there every
 now and then.
 now and then.
@@ -203,4 +187,3 @@ now and then.
 Using the CivetWeb project ensures the MIT licenses terms are applied and
 Using the CivetWeb project ensures the MIT licenses terms are applied and
 GPL cannot be imposed on any of this code, as long as it is sourced from
 GPL cannot be imposed on any of this code, as long as it is sourced from
 here. This code will remain free with the MIT license protection.
 here. This code will remain free with the MIT license protection.
-