diff --git a/doc/gettingstarted.rst b/doc/gettingstarted.rst new file mode 100644 index 0000000..3a0b1bb --- /dev/null +++ b/doc/gettingstarted.rst @@ -0,0 +1,10 @@ +Getting Started +=============== + +For now here is just a working example. +You can find it in the examples directory of the source distribution. + +.. literalinclude:: ../examples/demo/demo.py + :language: python + + diff --git a/doc/index.rst b/doc/index.rst index dd2fd0e..82a7625 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -4,14 +4,14 @@ Web Services Made Easy Introduction ------------ -Web Service Made Easy (wsme) is a very easy way to implement webservices -in your python web application. It is a rewrite of TGWebServices with -focus on extensibility and framework-independance. +Web Service Made Easy (WSME) is a very easy way to implement webservices +in your python web application. It is originally a rewrite of TGWebServices +with focus on extensibility and framework-independance. Main features are: - Very simple API -- Support user defined complex types. +- Supports user defined complex types. - Multi-protocol : REST+Json, REST+XML, SOAP, and more to come - Extensible : easy to add more protocols or more base types. - WSGI application : can be used within any web framework @@ -24,6 +24,7 @@ Contents .. toctree:: :maxdepth: 2 + gettingstarted api Indices and tables