diff --git a/README.md b/README.md index a0a57b4..42516cc 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Maintainability](https://api.codeclimate.com/v1/badges/505e1372f12d2ec7eb0b/maintainability)](https://codeclimate.com/github/ElectronicBabylonianLiterature/fragment-hit-counter/maintainability) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) -The hit counter script extracts fragments hits from a catalogue. For each fragment in the catalogue the documents starting with `BC` are collected and saved to the database under `uncuratedReferences` property as a list of objects with "File name" column without extension and quotes as `document` and the list of pages from the "Page" as integers as `pages`. +The script extracts fragments references from a catalogue. For each fragment in the catalogue the documents not starting with `BC` are collected and saved to the database under `uncuratedReferences` property as a list of objects with "File name" column without extension and quotes as `document` and the list of pages from the "Page" as integers as `pages`. Usage: @@ -54,6 +54,6 @@ The fragment ID is parsed from the file name: - `AA-BB-CC 0DD.csv.csv` => `18AA,.
` - `AA-BB-CC,DD.csv` => `18AA,.
` -Hits from different files resulting in same fragment ID are summed for the final result. +References from different files resulting in same fragment ID are combined for the final result. If the file name does not match any pattern the file is ignored.