mozilla / loci

UNMAINTAINED! An experimental addon that enriches the data about places in Firefox
Mozilla Public License 2.0
2 stars 6 forks source link

Add better README w/ details #13

Open pdehaan opened 8 years ago

pdehaan commented 8 years ago

Probably a good thing for casual passers-by.

UPDATE: PR #14 landed, but the README could still use some actual project details.


Could even be a rough copy-pasta of Olivier's intro email (with a link back to the Activity Stream repo):

Loci is greek for "places". The word is also used in Sherlock Holme's memory technique, the method of loci a.k.a. the mind palace technique.

~~The main goal of this project is to prototype full-text search storage and retrieval in gecko. To achieve our goal, we are implementing the background job infrastructure in this project, and this infrastructure will be re-used in Activity Stream to collect all local metadata.~~

rlr commented 8 years ago

Also needs a LICENSE file to be legit open source. I know, pull requests welcome.

oyiptong commented 8 years ago

Indeed :-)

pdehaan commented 8 years ago

Basic README.md and LICENSE (stolen from Activity-Stream repo) added in #14, but I'd vote to keep this issue open until somebody rewrites the README to add basic instructions and a better description.