itemsapi / itemsjs

Extremely fast faceted search engine in JavaScript - lightweight, flexible, and simple to use
Apache License 2.0
346 stars 41 forks source link

Update config parameters in README.md #126

Closed ClaudeDufour74 closed 1 year ago

ClaudeDufour74 commented 1 year ago

I needed to use the functionalities of "isExactSearch" and "removeStopWordFilter".

Based on my understanding of actual documentation, I was under the impression that "isExactSearch" and "removeStopWordFilter" were options that could be passed to "itemjs.search(options)" function until I found out they actually were attributes that are used for defining global configuration in "ItemsJS(data, [configuration])".

Can you confirm that "isExactSearch" and "removeStopWordFilter" are configuration parameters used when instantiating "itemjs" object and not options to be used while calling "itemjs.search(options)"?

If my understanding is right, changes part of current pull request will adjust the documentation found in README.md.

P.S. It is the first time I contribute to a public repo. Please feel free to let me know if something needs to be changed in my approach of proposing a change.

Regards,

Claude

cigolpl commented 1 year ago

Thank you for your contribution to the repository! Yes, I can confirm that "isExactSearch" and "removeStopWordFilter" are indeed configuration parameters used when instantiating the "itemjs" object with "ItemsJS(data, [configuration])" and not options to be passed to the "itemjs.search(options)" function. Your understanding is correct.

Your pull request to adjust the documentation in README.md to clarify this is much appreciated. It will help other users to better understand the correct usage of these parameters.

As a first-time contributor to a public repo, your approach to proposing a change is great, and your message is clear and well-explained. Keep up the good work, and please feel free to continue contributing to the project!