search

ukwa / webarchive-discovery

WARC and ARC indexing and discovery tools.
https://github.com/ukwa/webarchive-discovery/wiki
115 stars 25 forks source link

Make a proper README #250

Open tokee opened 3 years ago

tokee commented 3 years ago

The real documentation is on the wiki, but the README is where people land when they see the project on GitHub, so it also needs to hold enough to explain what this is all about. Currently it is dominated by the Elasticsearch documentation and besides that says very little. It should be expanded quite a bit.

anjackson commented 3 years ago

Good idea. Should we move the Solr Quickstart stuff into the README? Or move the ES stuff into the wiki?

I found some templates that help me think about what could be included: