nikon/docsearch
1
0
Fork 0
Code Activity Actions

docs(global): Add section on "powered by Algolia" attribution (#194)

Browse source 
docs(global): Add section on "powered by Algolia" attribution

This is a tacit agreement, but imho it should really be stated somewhere explicitly.

* docs(global): Fix powered => search
This commit is contained in:
Daniel Maher 2017-10-10 14:26:24 +02:00 committed by GitHub
parent f3c50cb115
commit 1360d37a71
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -86,6 +86,17 @@ npm install --save docsearch.js
## Customization
### Attribution
We're happy to provide DocSearch free of charge for your site, and you're
welcome to customise that experience in a way that works for you; all we ask is
that Algolia be attributed within the search context. For example, in the
default implementation, we place a small "Search by Algolia" logo in the
corner. If you prefer to roll your own UX, you'll need to make sure that this
logo is included in your implementation as well.
### Default styling
The default colorscheme is white and gray:
![Default colorscheme][17]