diff --git a/README.md b/README.md index a31f2f5..f3eb5b7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # diagram-parser -Experimental project which extracts PIS codes from diagrams received via email and automatically creates an issue if any are found that are not present in the data repo. \ No newline at end of file +This is an experimental project and is not yet used as part of the OwlBoard stack. + +## Aims + +The aim of diagram-parser is to simplify the addition of PIS codes that are not yet in the OwlBoard data source. The planned implementation is as follows: + + - diagram-parser is subscribed to an email inbox (IMAP/POP3) + - Formatted train-crew schedule cards are sent to the inbox (DOCX format) and loaded by diagram-parser + - List of existing PIS codes is loaded and a list of non-existent codes is compiled (0000-9999) + - If a code is found both in the diagram and on the list of non-existent codes, a Gitea issue is opened providing details of the code. + - Once the program has run and extracted only the relavent details, the email is deleted and the file is closed and not stored. + - The evantual aim is to avoid any manual searching of the DOCX files. + +The current process of adding new codes involves being made aware of them face to face, or finding them myself and manually finding and adding them to the data source. \ No newline at end of file