@string-searching/specification/README.md

String searching specification for JavaScript

:scroll: [@string-searching/specification](https://string-searching.github.io/specification)
==

String searching specification for JavaScript.
See [docs](https://string-searching.github.io/specification/index.html).

> :building_construction: Caveat emptor! This is work in progress. Code may be
> working. Documentation may be present. Coherence may be. Maybe.

> :warning: Depending on your environment, the code may require
> `regeneratorRuntime` to be defined, for instance by importing
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).

[![License](https://img.shields.io/github/license/string-searching/specification.svg)](https://raw.githubusercontent.com/string-searching/specification/main/LICENSE)
[![Version](https://img.shields.io/npm/v/@string-searching/specification.svg)](https://www.npmjs.org/package/@string-searching/specification)
[![Tests](https://img.shields.io/github/workflow/status/string-searching/specification/ci:test?event=push&label=tests)](https://github.com/string-searching/specification/actions/workflows/ci:test.yml?query=branch:main)
[![Dependencies](https://img.shields.io/david/string-searching/specification.svg)](https://david-dm.org/string-searching/specification)
[![Dev dependencies](https://img.shields.io/david/dev/string-searching/specification.svg)](https://david-dm.org/string-searching/specification?type=dev)
[![GitHub issues](https://img.shields.io/github/issues/string-searching/specification.svg)](https://github.com/string-searching/specification/issues)
[![Downloads](https://img.shields.io/npm/dm/@string-searching/specification.svg)](https://www.npmjs.org/package/@string-searching/specification)

[![Code issues](https://img.shields.io/codeclimate/issues/string-searching/specification.svg)](https://codeclimate.com/github/string-searching/specification/issues)
[![Code maintainability](https://img.shields.io/codeclimate/maintainability/string-searching/specification.svg)](https://codeclimate.com/github/string-searching/specification/trends/churn)
[![Code coverage (cov)](https://img.shields.io/codecov/c/gh/string-searching/specification/main.svg)](https://codecov.io/gh/string-searching/specification)
[![Code technical debt](https://img.shields.io/codeclimate/tech-debt/string-searching/specification.svg)](https://codeclimate.com/github/string-searching/specification/trends/technical_debt)
[![Documentation](https://string-searching.github.io/specification/badge.svg)](https://string-searching.github.io/specification/source.html)
[![Package size](https://img.shields.io/bundlephobia/minzip/@string-searching/specification)](https://bundlephobia.com/result?p=@string-searching/specification)