Skip to content

Commit

Permalink
Clean up README
Browse files Browse the repository at this point in the history
  • Loading branch information
Devin Torres committed Feb 24, 2011
1 parent c79c7a0 commit e1879a1
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 26 deletions.
49 changes: 24 additions & 25 deletions README.md
Expand Up @@ -2,59 +2,60 @@ Detergent - An emulsifying Erlang SOAP library
==============================================

Detergent helps make SOAP interactions in Erlang
uhh... cleaner (no pun intended)!
uhh... cleaner (pun totally intended)!

## History

Most code in Detergent was originally extracted from
the SOAP implementation in Yaws, the idea being
to make this more readily available without having
to install Yaws itself.
Most code in Detergent was originally extracted
from the SOAP implementation in Yaws, the idea
being to make this more readily available without
having to install Yaws itself.

There are obviously changes Detergent that make it
different from the Yaws implementation, and these will
continue. Hopefully, these changes make Detergent, easier
to use.
There are obviously changes in Detergent that
make it different from the Yaws implementation,
and these will continue. Hopefully these changes
make Detergent easier to use.

## Dependencies

Detergent depends on the excellent Erlsom library for all
XML interactions. In my opinion, Erlsom has managed take
away quite a bit of the pain of working with XML.
Detergent depends on the excellent Erlsom library
for all XML interactions. Erlsom takes away quite
a bit of the pain of working with XML.

## Building

Detergent uses rebar for building and wraps it up in a Makefile
for convenience.
Detergent uses rebar for building and wraps it i
a Makefile for convenience.

First clone detergent from github:
First clone Detergent from GitHub:

$ git clone git://github.com/devinus/detergent.git

Then change into the newly created directory:

$ cd detergent

And make
And make:

$ make

Rebar will first pull in erlsom as a dependency from github,
attempt to build it, then build detergent.
Rebar will first pull in Erlsom as a dependency
from GitHub, attempt to build it, then build
Detergent.

## Testing

To test your detergent build, start and erlang shell and run
the detergent:qtest/0.
To test your Detergent build, start an Erlang
shell and run the detergent:qtest/0 function.

The qtest/0 function attempts to call a webservice at webservicex.net to
retrieve the weather repeat for Boston ;)
The qtest/0 function attempts to call a web
service at webservicex.net to retrieve the
weather repeat for Boston.

$ erl -pa deps/erlsom/ebin ebin
> inets:start().
> detergent:qtest().


License
=======

Expand All @@ -63,5 +64,3 @@ and you can find his license in LICENSE.

Anything else is provided under public domain
which you can learn more about in UNLICENSE.


1 change: 0 additions & 1 deletion ebin/detergent.app
@@ -1,4 +1,3 @@
% -*- mode: erlang -*-
{application, detergent,
[{description, "An emulsifying Erlang SOAP library"},
{vsn, "0.2"},
Expand Down

0 comments on commit e1879a1

Please sign in to comment.