From 7c1ca2cd6fceb8821fcb3cc55a40a1376dbc5c4b Mon Sep 17 00:00:00 2001 From: mtfum Date: Sat, 31 Jul 2021 10:42:08 -0700 Subject: [PATCH] :memo: update README --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 01e954b..4a1d414 100644 --- a/README.md +++ b/README.md @@ -30,17 +30,31 @@ let client = NewsAPI(apiKey: "YOUR_API_KEY") ### Get Sources ```Swift -let articles = try await client.getSources() +let articles = try await client.getSources( + sources: [String] = [], // abc-news, bbc-news, etc... + query: String? = nil, + category: NewsSourceCategory? = nil, + language: Language = Language.en +) ``` ### Search ```Swift -let articles = try await client.search(query: "bitcoin") +let articles = try await client.search( + query: "", + sources: [String] = [], + sortBy: SortBy? = nil, // relevancy, popularity, publishedAt + language: Language? = nil +) ``` ### Top-Headlines ```Swift -let articles = try await client.getTopHeadlines() +let articles = try await client.getTopHeadlines( + category: NewsSourceCategory? = nil, + language: Language? = nil, + country: Country? = nil +) ```