From ff7d6134f15e809b8b5108bd12ff27559ff67b2f Mon Sep 17 00:00:00 2001 From: Ladd Hoffman Date: Fri, 15 Jul 2022 10:57:27 -0500 Subject: [PATCH] semantic-scholar-client: Extend Readme --- semantic-scholar-client/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/semantic-scholar-client/README.md b/semantic-scholar-client/README.md index b9de209..2ff88f0 100644 --- a/semantic-scholar-client/README.md +++ b/semantic-scholar-client/README.md @@ -2,3 +2,15 @@ This utility is able to fetch data fromSemantic Scholar API. Initial proof of concept here writes the result to stdout. Work in progress to pipe this data into an operating database. +### Usage + + cargo run -- --paper-id + +`paper_id` is in accordance with [Semantic Scholar API](https://api.semanticscholar.org/api-docs/) rules. + +In its current form the utility outputs the citation graph up to a depth of 3 citations. + +Next steps include +- developing strategies for deciding where to terminate a given traversal +- providing an HTTP and perhaps WebSocket interface that can be used to talk to this process during its operation. + This can enable us to pipe the data to other tasks, to monitor, to start/stop, and even to make configuration changes. \ No newline at end of file