Skip to content

Commit

Permalink
docs: add headings to usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
trovster committed Oct 5, 2023
1 parent 15aeafd commit 80a2e6b
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ this is converted to *miles*, but you can change this to kilometres using
></fitness-ring>
```

### Custom Text

You can provide a custom header by using the named `<slot>`. You can also change
the text for “move”, “exercise” and “stand”.

Expand All @@ -69,10 +71,14 @@ the text for “move”, “exercise” and “stand”.
</fitness-card>
```

### Replayable

The activity rings animation can be replayed when using the `replayable="true"`
attribute. When the activity rings are clicked, the animation is replayed in
reverse, then completed again.

### Styling

The typeface and colours of the text and rings can be altered using CSS
variables. The `--fitness-value` controls the colour of the *values* in the
footer.
Expand Down

0 comments on commit 80a2e6b

Please sign in to comment.