holmes-app / holmes-api

API for holmes website validation.
MIT License
17 stars 7 forks source link

Please provide some installation instruction #19

Open sfermigier opened 10 years ago

sfermigier commented 10 years ago

Hi,

the README is quite terse. Is there any we can get both a slightly more detailed description, and some installation instructions ?

Regards,

S.

heynemann commented 10 years ago

We are finishing our first alpha release. As soon as we finish it, we'll clean it up a little bit and document how to get a holmes farm working.

heynemann commented 10 years ago

Sorry for the delay, man. We definitely will provide docs at some point, but right now we are doing performance tuning. Globo.com has more than 50M pages, thus making the actual crawling A LOT harder than what you'd expect for smaller sites.

That is a great use case for holmes, though. When we manage to get it to a speed that actually makes us happy, smaller sites will be able to use it VERY easily and fast.

As soon as we get it working I promise we'll have a comprehensive documentation on how to use and how to contribute to it.

heynemann commented 10 years ago

Reopening since we still do not provide usage instructions. When we get our docs up-and-running we'll close this.