From 82eb12b1cd3fa0fec054d3dc0a2ae09de40b866f Mon Sep 17 00:00:00 2001 From: webbrain-one <295484252+webbrain-one@users.noreply.github.com> Date: Mon, 10 Aug 2026 18:47:46 +0300 Subject: [PATCH] docs: improve README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0372993..3981c4b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # Nimrag [![Actions Status](https://github.com/arathunku/nimrag/actions/workflows/elixir-build-and-test.yml/badge.svg)](https://github.com/arathunku/nimrag/actions/workflows/elixir-build-and-test.yml) @@ -56,14 +58,14 @@ credentials = Nimrag.Credentials.new("username", "password") Use functions from `Nimrag` to fetch data from Garmin's API. ```elixir -# Restore previously cached in ~/.nimrag OAuth tokens +# Restore previously cached in ~/.config/nimrag OAuth tokens client = Nimrag.Client.new() |> Nimrag.Client.with_auth(Nimrag.Credentials.read_oauth_tokens!()) # Fetch your profile {:ok, %Nimrag.Api.Profile{} = profile, client} = Nimrag.profile(client) # Fetch your latest activity -{:ok, %Nimrag.Api.Activity{} = activity, client} = Nimrag.last_activity(client) +{:ok, %Nimrag.Api.ActivityList{} = activity, client} = Nimrag.last_activity(client) # Call at the end of the session to cache new OAuth2 token :ok = Nimrag.Credentials.write_fs_oauth2_token(client)