Browse Source

Update README and RELEASE_NOTES

bel2125 8 năm trước cách đây
mục cha
commit
ebc69d7e7d
2 tập tin đã thay đổi với 28 bổ sung31 xóa
  1. 21 25
      README.md
  2. 7 6
      RELEASE_NOTES.md

+ 21 - 25
README.md

@@ -1,12 +1,10 @@
 ![CivetWeb](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/civetweb_64x64.png "CivetWeb") CivetWeb
 =======
 
-[![License](https://img.shields.io/badge/license-MIT-blue.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)
-
-
 **The official home of CivetWeb is [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)
+[![GitHub contributors](https://img.shields.io/github/contributors/civetweb/civetweb.svg)](https://github.com/civetweb/civetweb/blob/master/CREDITS.md)
 
 Continuous integration for Linux and OSX ([Travis CI](https://travis-ci.org/civetweb/civetweb)):
 
@@ -41,7 +39,7 @@ It can also be used by end users as a stand-alone web server. It is available as
 Where to find the official version?
 -----------------------------------
 
-End users can download CivetWeb at SourceForge
+End users can download CivetWeb releases at SourceForge
 [https://sourceforge.net/projects/civetweb/](https://sourceforge.net/projects/civetweb/)
 
 Developers can contribute to CivetWeb via GitHub
@@ -56,6 +54,9 @@ Discussion/support group and announcements are at Google Groups
 Source releases can be found on GitHub
 [https://github.com/civetweb/civetweb/releases](https://github.com/civetweb/civetweb/releases)
 
+A very brief overview can be found on GitHub Pages
+[http://civetweb.github.io/civetweb/](http://civetweb.github.io/civetweb/)
+
 
 Quick start documentation
 --------------------------
@@ -104,30 +105,24 @@ simplicity by a carefully selected list of features:
 
 ### Optionally included software
 
-<a href="http://lua.org">
-![Lua](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/lua-logo.jpg "Lua Logo")
-</a>
-<a href="http://sqlite.org">
-![Sqlite3](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/sqlite3-logo.jpg "Sqlite3 Logo")
-</a>
-<a href="http://keplerproject.github.io/luafilesystem/">
-![LuaFileSystem](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luafilesystem-logo.jpg "LuaFileSystem Logo")
-</a>
-<a href="http://lua.sqlite.org/index.cgi/index">
-![LuaSQLite3](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luasqlite-logo.jpg "LuaSQLite3 Logo")
-</a>
-<a href="http://viremo.eludi.net/LuaXML/index.html">
-![LuaXML](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luaxml-logo.jpg "LuaXML Logo")
-</a>
-<a href="http://duktape.org">
-![Duktape](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/duktape-logo.png "Duktape Logo")
-</a>
+[![Lua](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/lua-logo.jpg "Lua Logo")](http://lua.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/)
+
+[![LuaSQLite3](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luasqlite-logo.jpg "LuaSQLite3 Logo")](http://lua.sqlite.org/index.cgi/index)
+
+[![LuaXML](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/luaxml-logo.jpg "LuaXML Logo")](http://viremo.eludi.net/LuaXML/index.html)
+
+[![Duktape](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/duktape-logo.png "Duktape Logo")](http://duktape.org)
 
 
 Support
 -------
 
-This project is very easy to install and use. Please read the [documentation](https://github.com/civetweb/civetweb/blob/master/docs/)
+This project is very easy to install and use. 
+Please read the [documentation](https://github.com/civetweb/civetweb/blob/master/docs/)
 and have a look at the [examples](https://github.com/civetweb/civetweb/blob/master/examples/).
 More information may be found on the [mailing list](https://groups.google.com/d/forum/civetweb).
 
@@ -138,7 +133,7 @@ Contributions
 Contributions are welcome provided all contributions carry the MIT license.
 
 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 are developed independently.
 By now the code base differs, so patches cannot be safely transfered in either direction.
 
 Some guidelines can be found in [docs/Contribution.md](https://github.com/civetweb/civetweb/blob/master/docs/Contribution.md).
@@ -164,3 +159,4 @@ A list of authors can be found in [CREDITS.md](https://github.com/civetweb/civet
 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
 here. This code will remain free with the MIT license protection.
+

+ 7 - 6
RELEASE_NOTES.md

@@ -1,20 +1,21 @@
 Release Notes v1.10 (work in progress)
 ===
-### Objectives: *OpenSSL 1.1 support + to be defined*
+### Objectives: *OpenSSL 1.1 support, add server statistics and diagnostic data*
 
 Changes
 -------
 
 - Add USE\_SERVER\_STATS define, so the server collects statistics data
-- Add experimental function to query the connection status
+- Convert system\_info text output and all other diagnostic strings to JSON format
+- Add experimental function to query the connection status (may be dropped again)
 - Add document on proposed future interface changes (for comments)
 - Officially drop Symbian support
-- Ignore leading blank lines in multipart messages (Android upload service)
+- Ignore leading blank lines in multipart messages (for Android upload service)
 - Rewrite some functions, in particular request parsing
 - CORS preflight directly in the server, with additional config options
 - Solve some warnings from different static source code analysis tools
 - Collect server status data
-- Allow hostname in listening_ports
+- Allow hostname in listening\_ports
 - Make maximum request size configurable
 - Allow multiple Sec-Websocket-Protocol
 - Add configuration option to send additional headers
@@ -22,10 +23,10 @@ Changes
 - Mark "file in memory" feature is a candidate for deletion
 - Improve examples
 - Fix timeout error when sending larger files
-- Add mg_send_chunk interface function
+- Add mg\_send\_chunk interface function
 - Allow to separate server private key and certificate chain in two different files
 - Support for multipart requests without quotes (for some C# clients)
-- Initialize SSL in mg_init_library, so https client functions can be used when no server is running
+- Initialize SSL in mg\_init\_library, so https client functions can be used when no server is running
 - Allow "REPORT" HTTP method for REST calls to scripts
 - Allow to compile civetweb.c wih a C++ compiler
 - Lua: Remove internal length limits of encode/decode functions