Skip to content

Commit

Permalink
Write a DESCRIPTION for the brief
Browse files Browse the repository at this point in the history
  • Loading branch information
kentfredric committed Aug 16, 2015
1 parent c5a83bc commit 5020828
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
16 changes: 16 additions & 0 deletions README.mkdn
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,22 @@ automatically.

This is an early release, `API` is prone to change without much warning, but best attempts will be made to avoid the need.

# DESCRIPTION

This module is an extension for the [`Search::GIN`](https://metacpan.org/pod/Search::GIN) framework
providing a novel way to dictate which attribute extraction techniques will be
used for which object by having rules that map against the objects inheritance
or the objects composed roles.

This essentially permits you to register adapters for various object types to
special-case their extraction.

For example, if you had a source tree that used classes under your control
using `MooseX::AttributeIndexes`, you could easily default those classes to
extract using `Search::GIN::Extract::AttributeIndexes`. And if any objects of
those classes had `DateTime` properties, you could define a handler for
extracting `DateTime` meta-data for indexing specifically.

# METHODS

## `extract_values`
Expand Down
16 changes: 15 additions & 1 deletion lib/Search/GIN/Extract/ClassMap.pm
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,18 @@ automatically.
This is an early release, C<API> is prone to change without much warning, but best attempts will be made to avoid the need.
=cut
=head1 DESCRIPTION
This module is an extension for the L<< C<Search::GIN>|Search::GIN >> framework
providing a novel way to dictate which attribute extraction techniques will be
used for which object by having rules that map against the objects inheritance
or the objects composed roles.
This essentially permits you to register adapters for various object types to
special-case their extraction.
For example, if you had a source tree that used classes under your control
using C<MooseX::AttributeIndexes>, you could easily default those classes to
extract using C<Search::GIN::Extract::AttributeIndexes>. And if any objects of
those classes had C<DateTime> properties, you could define a handler for
extracting C<DateTime> meta-data for indexing specifically.

0 comments on commit 5020828

Please sign in to comment.