Skip to content

Commit

Permalink
Add installation section to README (#402)
Browse files Browse the repository at this point in the history
  • Loading branch information
bokub authored Jul 31, 2023
1 parent bb363ab commit c8c0c85
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,16 @@ npx http-server -o
# A browser will open, navigate to example.html
```

## Installation

```bash
# With npm
npm i home-assistant-js-websocket

# With yarn
yarn add home-assistant-js-websocket
```

## Usage

To initialize a connection, you need an authentication token for the instance that you want to connect to. This library implements the necessary steps to guide the user to authenticate your website with their Home Assistant instance and give you a token. All you need from the user is the url of their instance.
Expand Down

0 comments on commit c8c0c85

Please sign in to comment.