picky

https://github.com/floere/picky

HTML

Picky is an easy to use and fast Ruby semantic search engine that helps your users find what they are looking for.

Picky::Search#search

This is the main entry point for a query.
Use this in specs and also for running queries.

Parameters:
* text:       The search text.
* ids = 20:   The amount of ids to calculate (with offset).
* offset = 0: The offset from which position to return the ids. Useful for pagination.

Options:
* unique: Whether to return unique ids.

Note: The Rack adapter calls this method after unravelling the HTTP request.

Source | Google | Stack overflow

Edit

git clone [email protected]:floere/picky.git

cd picky

open server/lib/picky/search.rb

Contribute

# Make a new branch

git checkout -b -your-name--update-docs-Picky--Search-search-for-pr

# Commit to git

git add server/lib/picky/search.rbgit commit -m "better docs for Picky::Search#search"

# Open pull request

gem install hub # on a mac you can `brew install hub`

hub fork

git push <your name> -your-name--update-docs-Picky--Search-search-for-pr

hub pull-request

# Celebrate!