backdrop-contrib / search_api

Provides a generic API for modules offering search capabilities
GNU General Public License v2.0
0 stars 5 forks source link

Simplify README #2

Closed ghost closed 3 years ago

ghost commented 4 years ago

The README is huge with way too much text for someone just wanting basic information about the module.

I suggest minimising the README info to match https://github.com/backdrop-ops/module-template/blob/master/README.md and moving the bulk of the detailed info to the wiki.

earlyburg commented 3 years ago

@BWPanda Hi, I have created a wiki page and updated the README as you suggested. https://github.com/backdrop-contrib/search_api/commit/fc8ec31fc2d7b1c423667db765b74ba614c707c3 I tried to be consistant with my re-write. Thanks for pointing this out. I'll wait for a few days before I do a release that will include this fix in case of any feedback for changes.