README

Overview

Uses the Swiftype Site Search API to push content as structured data to one or more Swiftype engines. Provides a client to search through the API.

For usage of the Swiftype Site Search Crawler, please use the ichaber/silverstripe-swiftype module instead.

SilverStripe 3

Originally built for SS4, a rework has been done to make this module compatible with SilverStripe 3. Please check this branch, https://github.com/marczhermo/swiftype-search/blob/3/README.md

Versioning

This library follows Semver. According to Semver, you will be able to upgrade to any minor or patch version of this library without any breaking changes to the public API. Semver also requires that we clearly define the public API for this library.

All methods, with public visibility, are part of the public API. All other methods are not part of the public API. Where possible, we'll try to keep protected methods backwards-compatible in minor/patch versions, but if you're overriding methods then please test your work before upgrading.

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.

License

This module is released under the BSD 3-Clause License