52 lines
2.3 KiB
Markdown
52 lines
2.3 KiB
Markdown
|
|
||
|
|
|
||
|
|
<p align="center"><a href="https://fusejs.io" target="_blank" rel="noopener noreferrer"><img width="200" src="https://fusejs.io/assets/images/logo.png" alt="Fuse.js logo"></a></p>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<a alt="Build Status" href="http://travis-ci.org/krisk/Fuse"><img src="https://secure.travis-ci.org/krisk/Fuse.svg?branch=master" /></a>
|
||
|
|
<a href="https://www.npmjs.com/package/fuse.js"><img src="https://img.shields.io/npm/v/fuse.js.svg" alt="Version"/></a>
|
||
|
|
<a href="https://npmcharts.com/compare/fuse.js?minimal=true"><img src="https://img.shields.io/npm/dm/fuse.js.svg" alt="Downloads" /></a>
|
||
|
|
<a href="https://github.com/krisk/Fuse/graphs/contributors"><img src="https://img.shields.io/github/contributors/krisk/fuse.svg" alt="Contributors" /></a>
|
||
|
|
<a href="https://www.npmjs.com/package/fuse.js"><img src="https://img.shields.io/npm/l/fuse.js.svg" alt="License"></a>
|
||
|
|
<!-- <a href="https://discord.gg/QF4B9sf"><img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat"></a> -->
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<h2 align="center">Supporting Fuse.js</h2>
|
||
|
|
|
||
|
|
Fuse.js is an Apache License open source project. Maintaining and updating it takes up a good chunk of time, and there's still plenty of work to do. To be able to provide the project with the attention it deserves, I decided to experiment with sponsorship and/or support. If this works out, I can route the chunk of time that is usually spent on lucrative endeavors to this project.
|
||
|
|
|
||
|
|
If you'd like to join the list of these awesome [backers](https://github.com/krisk/Fuse/blob/master/backers.md), please consider:
|
||
|
|
|
||
|
|
- [Become a backer or sponsor on Patreon](https://www.patreon.com/fusejs).
|
||
|
|
- [One-time donation via PayPal](https://www.paypal.me/kirorisk)
|
||
|
|
|
||
|
|
|
||
|
|
<h3 align="center">Special Sponsors</h3>
|
||
|
|
<!--special start-->
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
<i>[Get your company name here]</i>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<!--special end-->
|
||
|
|
---
|
||
|
|
|
||
|
|
## Introduction
|
||
|
|
|
||
|
|
Fuse.js is a lightweight fuzzy-search, in JavaScript, with zero dependencies.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
To checkout out [live examples](https://fusejs.io) and docs, visit [fusejs.io](https://fusejs.io).
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
### Coding conventions
|
||
|
|
|
||
|
|
Code should be run through [Standard Format](https://www.npmjs.com/package/standard-format).
|
||
|
|
|
||
|
|
### Testing
|
||
|
|
|
||
|
|
Before submitting a pull request, please add relevant tests in `test/index.js`, and execute them via `npm test`.
|
||
|
|
|