fergiemcdowall / norch

A search server that can be installed with npm

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Make better docs

fergiemcdowall opened this issue · comments

Docs should be shorter and better

Shorter? What am I missing :)

Some docs using it via API and not via HTTP would be great. That's said just looking at

https://github.com/fergiemcdowall/norch/blob/master/lib/norch.js

is a good start.

Ah, I see norch is just the server for

https://github.com/fergiemcdowall/search-index

...which has actually has decent docs :)

Yes =)
search-index has gotten shorter docs, but it still needs to be a little better. Let us know if you find documentation that could be done better, @tcurdt