whooshy

A fork of Whoosh project
Used by matchup »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Integration
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Built With

Getting Started

Usage

Roadmap

The project is in the early stages of development. Thus, feel free to contribute and help WhooshY to grow up!

Actual Roadmap is:

1. Implement indexing
2. Implement matching / scoring
3. Integrate with matchup

See the open issues for a list of proposed features (and known issues).

OBS: To propose new features or report bugs, check out the correct templates.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This software is licensed under the terms of the simplified BSD (A.K.A. "two clause" or "FreeBSD") license. See LICENSE for information.

Contact

Marcos Pontes - mfprezende@gmail.com

Project Link: https://github.com/matchup-ir/whooshy