diff --git a/README.md b/README.md index 1049073..a802db8 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ YaCyIndexerGreasemonkey ======================= -Greasemonkey script to index visited websites with the [YaCy P2P search engine](http://yacy.net/). +This is a Greasemonkey script to index visited websites with the [YaCy P2P search engine](http://yacy.net/). It has the advantage over YaCy's proxy server that it can index pages with cookies, and (in many case) pages with query strings, without leaking private data. It can also crawl visited pages with a depth other than 0 (something YaCy's proxy does not support). Installation (Basic) -------------------- -If you want to use the default settings (crawl depth 1), just view the yacy_indexer.user.js file in GitHub and click the "Raw" link. Greasemonkey should prompt you to install the script. +First off, if you haven't installed [YaCy](http://yacy.net/en/index.html), you should do that first. + +You should also install Greasemonkey in Firefox, or a compatible add-on depending on your browser. + +Finally, just view the yacy_indexer.user.js file in GitHub and click the "Raw" link. Greasemonkey should prompt you to install the script. + +If you want to use the default settings (crawl depth 1), you're done! Otherwise, see the next section. Installation (Custom Settings) ------------------------------