From f5a8573a4e1a87a9de06647872d3d8c1510d123e Mon Sep 17 00:00:00 2001 From: Andreas Schamberger Date: Sat, 24 Aug 2013 17:31:35 +0200 Subject: [PATCH 1/2] Add readme files --- README.md | 56 +++++++++++++++++++++++++++++++ src/BeSimple/SoapClient/README.md | 34 +++++++++++++++++++ src/BeSimple/SoapCommon/README.md | 33 ++++++++++++++++++ src/BeSimple/SoapServer/README.md | 33 ++++++++++++++++++ src/BeSimple/SoapWsdl/README.md | 27 +++++++++++++++ 5 files changed, 183 insertions(+) create mode 100644 README.md create mode 100644 src/BeSimple/SoapClient/README.md create mode 100644 src/BeSimple/SoapCommon/README.md create mode 100644 src/BeSimple/SoapServer/README.md create mode 100644 src/BeSimple/SoapWsdl/README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..52ebf6d --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# BeSimpleSoap [![Build Status](https://secure.travis-ci.org/BeSimple/BeSimpleSoap.png?branch=master)](http://travis-ci.org/BeSimple/BeSimpleSoap) + +Build SOAP and WSDL based web services + +# Components + +BeSimpleSoap consists of five components ... + +## BeSimpleSoapBundle + +The BeSimpleSoapBundle is a Symfony2 bundle to build WSDL and SOAP based web services. +For further information see the [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapBundle/README.md). + +## BeSimpleSoapClient + +The BeSimpleSoapClient is a component that extends the native PHP SoapClient with further features like SwA, MTOM and WS-Security. +For further information see the [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapClient/README.md). + +## BeSimpleSoapCommon + +The BeSimpleSoapCommon component contains functionylity shared by both the server and client implementations. +For further information see the [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapCommon/README.md). + + +## BeSimpleSoapServer + +The BeSimpleSoapServer is a component that extends the native PHP SoapServer with further features like SwA, MTOM and WS-Security. +For further information see the [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapServer/README.md). + +## BeSimpleSoapWsdl + +For further information see the [README](https://github.com/BeSimple/BeSimpleSoap/blob/master/src/BeSimple/SoapWsdl/README.md). + +# Installation + +If you do not yet have composer, install it like this: + +```sh +curl -s http://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin +``` + +Create a `composer.json` file: + +```json +{ + "require": { + "besimple/soap": "dev-master" + } +} +``` + +Now you are ready to install the library: + +```sh +php /usr/local/bin/composer.phar install +``` \ No newline at end of file diff --git a/src/BeSimple/SoapClient/README.md b/src/BeSimple/SoapClient/README.md new file mode 100644 index 0000000..4da5016 --- /dev/null +++ b/src/BeSimple/SoapClient/README.md @@ -0,0 +1,34 @@ +# BeSimpleSoapClient + +The BeSimpleSoapClient is a component that extends the native PHP SoapClient with further features like SwA, MTOM and WS-Security. + +# Features (only subsets of the linked specs implemented) + +* SwA: SOAP Messages with Attachments [Spec](http://www.w3.org/TR/SOAP-attachments) +* MTOM: SOAP Message Transmission Optimization Mechanism [Spec](http://www.w3.org/TR/soap12-mtom/) +* WS-Security [Spec1](http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf), [Spec2](http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0.pdf) +* WS-Adressing [Spec](http://www.w3.org/2002/ws/addr/) + +# Installation + +If you do not yet have composer, install it like this: + +```sh +curl -s http://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin +``` + +Create a `composer.json` file: + +```json +{ + "require": { + "besimple/soap-client": "dev-master" + } +} +``` + +Now you are ready to install the library: + +```sh +php /usr/local/bin/composer.phar install +``` \ No newline at end of file diff --git a/src/BeSimple/SoapCommon/README.md b/src/BeSimple/SoapCommon/README.md new file mode 100644 index 0000000..42b02ab --- /dev/null +++ b/src/BeSimple/SoapCommon/README.md @@ -0,0 +1,33 @@ +# BeSimpleSoapCommon + +The BeSimpleSoapCommon component contains functionylity shared by both the server and client implementations. + +# Features + +* Common interfaces for SoapClient and SoapServer input/output processing flow +* MIME parser for SwA and MTOM implementation +* Soap type converters + +# Installation + +If you do not yet have composer, install it like this: + +```sh +curl -s http://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin +``` + +Create a `composer.json` file: + +```json +{ + "require": { + "besimple/soap-common": "dev-master" + } +} +``` + +Now you are ready to install the library: + +```sh +php /usr/local/bin/composer.phar install +``` \ No newline at end of file diff --git a/src/BeSimple/SoapServer/README.md b/src/BeSimple/SoapServer/README.md new file mode 100644 index 0000000..ce004da --- /dev/null +++ b/src/BeSimple/SoapServer/README.md @@ -0,0 +1,33 @@ +# BeSimpleSoapServer + +The BeSimpleSoapServer is a component that extends the native PHP SoapServer with further features like SwA, MTOM and WS-Security. + +# Features (only subsets of the linked specs implemented) + +* SwA: SOAP Messages with Attachments [Spec](http://www.w3.org/TR/SOAP-attachments) +* MTOM: SOAP Message Transmission Optimization Mechanism [Spec](http://www.w3.org/TR/soap12-mtom/) +* WS-Security [Spec1](http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf), [Spec2](http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0.pdf) + +# Installation + +If you do not yet have composer, install it like this: + +```sh +curl -s http://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin +``` + +Create a `composer.json` file: + +```json +{ + "require": { + "besimple/soap-server": "dev-master" + } +} +``` + +Now you are ready to install the library: + +```sh +php /usr/local/bin/composer.phar install +``` \ No newline at end of file diff --git a/src/BeSimple/SoapWsdl/README.md b/src/BeSimple/SoapWsdl/README.md new file mode 100644 index 0000000..1f50d4e --- /dev/null +++ b/src/BeSimple/SoapWsdl/README.md @@ -0,0 +1,27 @@ +# BeSimpleSoapWsdl + +TODO ... + +# Installation + +If you do not yet have composer, install it like this: + +```sh +curl -s http://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin +``` + +Create a `composer.json` file: + +```json +{ + "require": { + "besimple/soap-wsdl": "dev-master" + } +} +``` + +Now you are ready to install the library: + +```sh +php /usr/local/bin/composer.phar install +``` \ No newline at end of file From dc4c9d21910c790405c6bdefb9a2d79b0920573c Mon Sep 17 00:00:00 2001 From: Andreas Schamberger Date: Wed, 30 Oct 2013 15:54:35 +0100 Subject: [PATCH 2/2] remove travis status in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 52ebf6d..f0d9609 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# BeSimpleSoap [![Build Status](https://secure.travis-ci.org/BeSimple/BeSimpleSoap.png?branch=master)](http://travis-ci.org/BeSimple/BeSimpleSoap) +# BeSimpleSoap Build SOAP and WSDL based web services