Skip to content

Commit

Permalink
tidy up README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pinkywafer committed Jan 15, 2020
1 parent 13bdb97 commit 0043985
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,6 @@ The 'anniversaries' component is a Home Assistant custom sensor which counts dow

**1.0.0 includes BREAKING CHANGES** read the [release notes](https://github.com/pinkywafer/anniversaries/releases/latest).

State Returned:

* The number of days remaining to the next occurance.

Attributes:

* years at next anniversary: number of years that will have passed at the next occurrence _(NOT displayed if year is unknown)_
* current years: number of years have passed since the first occurance (ie, current age) _(NOT displayed if year is unknown)_
* date: The date of the first occurence _(or the date of the next occurence if year is unknown)_ (formatted by the date_format attribute if set)
* weeks_remaining: The number of weeks until the anniversary

## Table of Contents

* [Installation](#installation)
Expand All @@ -33,6 +22,8 @@ Attributes:
* [Configuration](#configuration)
* [Configuration Parameters](#configuration-parameters)
* [State and Attributes](#state-and-attributes)
* [State](#state)
* [Attributes](#attributes)

## Installation

Expand Down Expand Up @@ -87,3 +78,16 @@ anniversaries:
| `days_as_soon` | Yes | Days in advance to display the icon defined in `icon_soon` **Default**: 1
| `icon_soon` | Yes | Icon if the anniversary is 'soon' **Default**: `mdi:calendar`
| `date_format` | Yes | formats the returned date **Default**: '%Y-%m-%d' _for reference, see [http://strftime.org/](http://strftime.org/)_

## State and Attributes

### State

* The number of days remaining to the next occurance.

### Attributes

* years at next anniversary: number of years that will have passed at the next occurrence _(NOT displayed if year is unknown)_
* current years: number of years have passed since the first occurance (ie, current age) _(NOT displayed if year is unknown)_
* date: The date of the first occurence _(or the date of the next occurence if year is unknown)_ (formatted by the date_format attribute if set)
* weeks_remaining: The number of weeks until the anniversary

0 comments on commit 0043985

Please sign in to comment.