From 137ed3888c94b4f1671d33867a620a000931b7e8 Mon Sep 17 00:00:00 2001 From: Jocelyn Fiat Date: Mon, 14 Nov 2011 18:46:37 +0100 Subject: [PATCH] updated README with links to sub READM.md --- README.md | 42 ++++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f262f7f7..aecc31e9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ +# Eiffel Web Framework + + +## Overview + Official project site for Eiffel Web Framework: * http://eiffel-world.github.com/Eiffel-Web-Framework/ For more information please have a look at the related wiki: * https://github.com/Eiffel-World/Eiffel-Web-Framework/wiki -How to get the source code? ---------------------------- +## How to get the source code? * git clone https://github.com/Eiffel-World/Eiffel-Web-Framework.git * cd Eiffel-Web-Framework @@ -19,21 +23,31 @@ Or using git version >= 1.6.5 ** cd ext/ise_library/curl ** geant compile -Overview --------- +## Libraries under 'library' -* library/server/ewsgi: Eiffel Web Server Gateway Interface -* library/server/ewsgi/connectors: various web server connectors for EWSGI -* library/server/libfcgi: Wrapper for libfcgi SDK +* server + * __ewsgi__: Eiffel Web Server Gateway Interface [read more](library/server/ewsgi/README.md) + * connectors: various web server connectors for EWSGI + * libfcgi: Wrapper for libfcgi SDK + * __wsf__: Web Server Framework [read more](library/server/wsf/README.md) + * request + * __router__: URL dispatching/routing based on uri, uri_template, or custom [read more](library/server/request/router/README.md) + * rest: experimental: RESTful library to help building RESTful services +* protocol + * __http__: HTTP related classes, constants for status code, content types, ... [read more](library/protocol/http/README.md) + * __uri_template__: URI Template library (parsing and expander) [read more](library/protocol/uri_template/README.md) +* client + * __http_client__: simple HTTP client based on cURL [read more](library/client/http_client/README.md) +* crypto + * eel + * eapml +* text + * __encoder__: Various simpler encoders: base64, url-encoder, xml entities, html entities [read more](library/text/encoder/README.md) +* error: very simple/basic library to handle error -* library/server/request/router: URL dispatching/routing based on uri, uri_template, or custom. -* library/server/request/rest: experimental: RESTful library to help building RESTful services +## Examples +.. -* library/protocol/http: HTTP related classes, constants for status code, content types, ... -* library/protocol/uri_template: URI Template library (parsing and expander) - -* library/error: very simple/basic library to handle error -* library/text/encoder: Various simpler encoder: base64, url-encoder, xml entities, html entities For more information please have a look at the related wiki: * https://github.com/Eiffel-World/Eiffel-Web-Framework/wiki