Skip to content

Commit

Permalink
Update README to include some screenshots of an example configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
YorkshireIoT committed Apr 2, 2023
1 parent 78780ef commit 5da05e8
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
This integration interfaces with the [Google Fit REST API][rest-api] to provide Google Fit
data within Home Assistant.

![Example](/res/example.png)

**This integration will set up the following platforms.**

Platform | Name |Description
Expand Down Expand Up @@ -68,7 +70,24 @@ Instead, follow the instruction in the Official home Assistant Docs for [Google

## Configuration is done in the UI

<!---->
Just go to Integrations->Add Integration and follow the steps.
If you have set the app you created in the Credentials configuration to publish
(which you should've done to avoid re-authentication problems) then you
will probably see a warning step asking if you want to proceed.

You can hit "Advanced", then "Proceed" as *you* are the 'developer' of the app,
as you created the app and credentials in your own account.

### Configuration Example Screenshots

![Add Integration](/res/add.png)
![Add Credentials](/res/add_credentials.png)
![Choose Google Account](/res/choose_account.png)
![Unverified Warning](/res/warning.png)
![Access Request with Scopes](/res/wants_access.png)
![Link Account](/res/link_account.png)
![Finished](/res/success.png)


## Contributions are welcome!

Expand Down
Binary file added res/add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added res/add_credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added res/choose_account.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added res/example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added res/link_account.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added res/success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added res/wants_access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added res/warning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5da05e8

Please sign in to comment.