From 955f73dee90e4a6c6e085c88c5ddd08003604374 Mon Sep 17 00:00:00 2001 From: Jocelyn Fiat Date: Mon, 14 Nov 2011 19:00:00 +0100 Subject: [PATCH] Added various README.md (using the markdown syntax) --- README | 1 - library/client/http_client/README.md | 14 +++++++++++++- library/protocol/http/README.md | 8 ++++++++ library/protocol/uri_template/README.md | 8 ++++++++ library/server/ewsgi/README.md | 7 +++++++ library/server/request/router/README.md | 10 ++++++++++ library/server/wsf/README.md | 14 ++++++++++++++ library/text/encoder/README.md | 12 ++++++++++++ 8 files changed, 72 insertions(+), 2 deletions(-) delete mode 120000 README create mode 100644 library/protocol/http/README.md create mode 100644 library/protocol/uri_template/README.md create mode 100644 library/server/ewsgi/README.md create mode 100644 library/server/request/router/README.md create mode 100644 library/server/wsf/README.md create mode 100644 library/text/encoder/README.md diff --git a/README b/README deleted file mode 120000 index 42061c01..00000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -README.md \ No newline at end of file diff --git a/library/client/http_client/README.md b/library/client/http_client/README.md index c070db51..50dcdac3 100644 --- a/library/client/http_client/README.md +++ b/library/client/http_client/README.md @@ -1 +1,13 @@ -Simple HTTP client implemented using Eiffel cURL library +# simple HTTP client + +## Overview + +## Requirements +* Eiffel cURL library +* cURL dynamic libraries in the PATH or the current directory (.dll or .so) + +## Usage + +## Examples + + diff --git a/library/protocol/http/README.md b/library/protocol/http/README.md new file mode 100644 index 00000000..f76da376 --- /dev/null +++ b/library/protocol/http/README.md @@ -0,0 +1,8 @@ +# HTTP library + +## Overview + +## Usage + +## Examples + diff --git a/library/protocol/uri_template/README.md b/library/protocol/uri_template/README.md new file mode 100644 index 00000000..9cbb2e26 --- /dev/null +++ b/library/protocol/uri_template/README.md @@ -0,0 +1,8 @@ +# URI Template + +## Overview + +## Usage + +## Examples + diff --git a/library/server/ewsgi/README.md b/library/server/ewsgi/README.md new file mode 100644 index 00000000..6880a633 --- /dev/null +++ b/library/server/ewsgi/README.md @@ -0,0 +1,7 @@ +# Eiffel Web Server Gateway Interface + +## Overview + +## Usage + +## diff --git a/library/server/request/router/README.md b/library/server/request/router/README.md new file mode 100644 index 00000000..53acff10 --- /dev/null +++ b/library/server/request/router/README.md @@ -0,0 +1,10 @@ +# Router library + +## Requirements +* [Web Server Framework](../../wsf) +* [URI Template](../../../protocol/rui_template) + +## Overview + +## Usage + diff --git a/library/server/wsf/README.md b/library/server/wsf/README.md new file mode 100644 index 00000000..b9dcc180 --- /dev/null +++ b/library/server/wsf/README.md @@ -0,0 +1,14 @@ +# Web Server Framework + +User friendly framework to build Eiffel Web server applications. +It is built on top of [EWSGI](../ewsgi/) to benefit from the various EWSGI connectors. + +## Requirements +* [EWSGI](../ewsgi) +* [HTTP](../../protocol/http) + +## Overview + +## Usage + +## Examples diff --git a/library/text/encoder/README.md b/library/text/encoder/README.md new file mode 100644 index 00000000..8f7316c0 --- /dev/null +++ b/library/text/encoder/README.md @@ -0,0 +1,12 @@ +# collection of Encoders + +## Overview + +## Requirements +* Eiffel encoding libraries + +## Usage + +## Examples + +