diff --git a/README b/README index 0f97224..f2e67bf 100644 --- a/README +++ b/README @@ -1,94 +1,399 @@ +NAME + HTML::Form - Class that represents an HTML form element + +SYNOPSIS + use HTML::Form; + $form = HTML::Form->parse($html, $base_uri); + $form->value(query => "Perl"); + + use LWP::UserAgent; + $ua = LWP::UserAgent->new; + $response = $ua->request($form->click); + +DESCRIPTION + Objects of the `HTML::Form' class represents a single HTML `
' instance. A form consists of a sequence of inputs that usually + have names, and which can take on various values. The state of a form + can be tweaked and it can then be asked to provide `HTTP::Request' + objects that can be passed to the request() method of `LWP::UserAgent'. + + The following methods are available: + + @forms = HTML::Form->parse( $html_document, $base_uri ) + @forms = HTML::Form->parse( $html_document, base => $base_uri, %opt ) + @forms = HTML::Form->parse( $response, %opt ) + The parse() class method will parse an HTML document and build up + `HTML::Form' objects for each