From 1443ef8931ab1f6281f2968917f55e41863260cc Mon Sep 17 00:00:00 2001 From: Steve White Date: Sun, 26 Jan 2025 00:12:22 -0600 Subject: [PATCH] Updated Readme --- .gitignore | 1 + README.md | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/.gitignore b/.gitignore index a6c57f5..ec51a17 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ *.json +*.swp diff --git a/README.md b/README.md index a98f906..7eb5aac 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,17 @@ func main() { ## API Reference ### FetchPapers(startDate, endDate, query string, maxResults int) ([]Paper, error) +startDate: Start date in format "YYYYMMDD" +endDate: End date in format "YYYYMMDD" +query: Search query +maxResults: Maximum number of results (1-2000) Fetches papers from arXiv API ### SaveToFile(papers []Paper, startDate, endDate, query string) error +papers: Array of Paper structs +startDate: Start date in format "YYYYMMDD" +endDate: End date in format "YYYYMMDD" +query: Search query Saves papers to a JSON file ## Dependencies