From 66726f45e53bdcd3f8876e640c285ebd0cb2751f Mon Sep 17 00:00:00 2001 From: Bryan Newbold Date: Fri, 29 Oct 2021 10:50:01 -0700 Subject: update README to use process_citation_xml() --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2b06da1..8bd31b8 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ Install using `pip`, usually within a `virtualenv`: pip install grobid_tei_xml -The main entry points are the function `process_document_xml(xml_text)` and -`process_citations_xml(xml_text)`, which return python dataclass objects. The -helper method `.to_dict()` can be useful for, eg, serializing these objects to -JSON. +The main entry points are the functions `process_document_xml(xml_text)` and +`process_citation_xml(xml_text)` (or `process_citation_list_xml(xml_text)` for +multiple citations), which return python dataclass objects. The helper method +`.to_dict()` can be useful for, eg, serializing these objects to JSON. ## Usage Examples @@ -97,7 +97,7 @@ grobid_resp = requests.post( ) grobid_resp.raise_for_status() -citation = grobid_tei_xml.parse_citations_xml(grobid_resp.text)[0] +citation = grobid_tei_xml.parse_citation_xml(grobid_resp.text) print(citation) ``` -- cgit v1.2.3