Browse Source

Added support

Kirollos Risk 1 year ago
parent
commit
f3a78d29a7
2 changed files with 16 additions and 24 deletions
  1. 15 24
      README.md
  2. 1 0
      backers.md

+ 15 - 24
README.md

@@ -1,36 +1,26 @@
 # Fuse.js
 
-*Lightweight fuzzy-search, in JavaScript, with zero dependencies*
+<p align="center">
+  <a alt="npm version" href="https://www.npmjs.com/package/fuse.js"><img src="https://badge.fury.io/js/fuse.js.svg"/></a>
+  <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 alt="Join the chat" href="https://gitter.im/fuselib/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/fuselib/Lobby.svg"/></a>
+</p>
 
-[![npm version](https://badge.fury.io/js/fuse.js.svg)](https://www.npmjs.com/package/fuse.js)
-[![Build Status](https://secure.travis-ci.org/krisk/Fuse.svg?branch=master)](http://travis-ci.org/krisk/Fuse)
-[![Join the chat at https://gitter.im/fuselib/Lobby](https://badges.gitter.im/fuselib/Lobby.svg)](https://gitter.im/fuselib/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Donate](https://img.shields.io/badge/Donate-PayPal-red.svg)](https://www.paypal.me/kirorisk)
-[![Donate](https://img.shields.io/badge/patreon-donate-red.svg)](https://www.patreon.com/fusejs)
+<h2 align="center">Supporting Fuse.js</h2>
 
-[![Twitter URL](https://img.shields.io/twitter/url/https/twitter.com/fold_left.svg?style=social&label=Follow%20%40kirorisk)](https://twitter.com/kirorisk)
+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.
 
-Check out the [demo & usage](http://fusejs.io/)
-
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**
+If you'd like to join the list of these awesome [backers](https://github.com/krisk/Fuse/blob/master/backers.md), please consider:
 
-- [Where-to-post summary](#where-to-post-summary)
-- [Contributing](#contributing)
-  - [Coding conventions](#coding-conventions)
-  - [Testing](#testing)
+- [Become a backer or sponsor on Patreon](https://www.patreon.com/fusejs).
+- [One-time donation via PayPal](https://www.paypal.me/kirorisk)
+---
 
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+## Introduction
 
-## Where-to-post summary
+Fuse.js is a lightweight fuzzy-search, in JavaScript, with zero dependencies.
 
-- How do I? -- [StackOverflow](https://stackoverflow.com/questions/ask?tags=fuse.js)
-- I got this error, why? -- [StackOverflow](https://stackoverflow.com/questions/ask?tags=fuse.js)
-- I got this error and I'm sure it's a bug -- file an [issue](https://github.com/krisk/Fuse/issues)
-- I have an idea/request -- file an [issue](https://github.com/krisk/Fuse/issues)
-- You're a horrible human being -- send me an [email](mailto:kirollos+github@gmail.com)
-- You're awesome -- support Fuse.js development with [Patreon](https://www.patreon.com/fusejs)/[PayPal](https://www.paypal.me/kirorisk)
+Check out the [demo & usage](http://fusejs.io/)
 
 ## Contributing
 
@@ -41,3 +31,4 @@ Code should be run through [Standard Format](https://www.npmjs.com/package/stand
 ### Testing
 
 Before submitting a pull request, please add relevant tests in `test/index.js`, and execute them via `npm test`.
+

+ 1 - 0
backers.md

@@ -4,3 +4,4 @@ You can join them in supporting Fuse.js development by [pledging on Patreon](htt
 
 - [Daniel Murawsky](https://github.com/dmurawsky ) of [Urgos](https://urgos.io)
 - John Sedrak of [Nomos Law](http://www.nomoslaw.com/)
+- Hemal Ruparelia