Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
release 1.008000 - README update
  • Loading branch information
mickeyn committed Nov 22, 2014
1 parent a86bdcd commit b296558
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.pod
Expand Up @@ -8,14 +8,14 @@ MetaCPAN::Client - A comprehensive, DWIM-featured client to the MetaCPAN API

=head1 VERSION

version 1.007001
version 1.008000

=head1 SYNOPSIS

# simple usage
my $mcpan = MetaCPAN::Client->new();
my $author = $mcpan->author('XSAWYERX');
my $dist = $mcpan->distribuion('MetaCPAN-Client');
my $dist = $mcpan->distribution('MetaCPAN-Client');

# advanced usage with cache (contributed by Kent Fredric)
use CHI;
Expand Down Expand Up @@ -146,7 +146,17 @@ returns a L<MetaCPAN::Client::ResultSet> of L<MetaCPAN::Client::Release>.

=head2 pod

Not implemented yet.
Get POD for given file/module name.
returns a L<MetaCPAN::Client::POD> object, which supports various output
formats (html, plain, x_pod & x_markdown).

my $pod = $mcpan->pod('Moo')->html;

=head2 all

Retrieve all matches for authors/modules/distributions or releases.

my $all_releases = $mcpan->all('releases')

=head2 BUILDARGS

Expand Down Expand Up @@ -196,6 +206,20 @@ key:
]
} );

If you want to do something even more complicated,
You can also nest your queries, e.g.:

my $gmail_daves_or_cpan_sams = $mcpan->author( {
either => [
{ all => [ { name => 'Dave *' },
{ email => '*gmail.com' } ]
},
{ all => [ { name => 'Sam *' },
{ email => '*cpan.org' } ]
},
],
} );

=head2 NOT

If you want to filter out some of the results of an either/all query
Expand Down

0 comments on commit b296558

Please sign in to comment.