From 81b290595d5d6ba01949c534adf4f3ed474d10d1 Mon Sep 17 00:00:00 2001 From: Brendan McDevitt Date: Tue, 12 Apr 2022 14:55:04 -0500 Subject: [PATCH] update readme --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b29ca7b..828d233 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,9 @@ For now unauthenticated api over localhost:3000 until I put in some basic token #### GithubUsers Create a text file named `./data/github_usernames.txt` with one username per line -There is a seed task that will read this file and perform an API call to github API and store the data in DB for each user. +There is a seed task that will read this file and perform an API call to github API and store the data in DB for each user. The API calls made are using the following graphQL endpoints: +- [User](https://docs.github.com/en/graphql/reference/objects#user) Note: the following keys are returned - github_id, login, name, avatar_url, bio, bio_html, location +- [RepositoryInfo](https://docs.github.com/en/graphql/reference/interfaces#repositoryinfo) Note: An array is returned of each public repository of the user. ``` get "/github_users", to: "github_users#index" get "/github_users/:username", to: "github_users#show"