Skip to content

Commit

Permalink
document CLIENT_OPTIONS
Browse files Browse the repository at this point in the history
  • Loading branch information
zoe-codez committed Aug 22, 2024
1 parent 2419fb8 commit e8a8508
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ Add the following to your application's configuration file.
password=super-strong-password
port=1883
```

or as json in your `.env`

```
CLIENT_OPTIONS={"host":"localhost","port":1883}
```

## 🛠 Usage

> Library is in an "experimental" state
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
},
"devDependencies": {
"@cspell/eslint-plugin": "^8.7.0",
"@digital-alchemy/core": "^24.7.2",
"@digital-alchemy/core": "^24.8.3",
"@types/figlet": "^1.5.8",
"@types/jest": "^29.5.12",
"@types/js-yaml": "^4.0.9",
Expand Down Expand Up @@ -65,5 +65,5 @@
"type-fest": "^4.15.0",
"typescript": "^5.4.5"
},
"packageManager": "yarn@4.3.1"
"packageManager": "yarn@4.4.0"
}
10 changes: 5 additions & 5 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -928,9 +928,9 @@ __metadata:
languageName: node
linkType: hard

"@digital-alchemy/core@npm:^24.7.2":
version: 24.7.2
resolution: "@digital-alchemy/core@npm:24.7.2"
"@digital-alchemy/core@npm:^24.8.3":
version: 24.8.3
resolution: "@digital-alchemy/core@npm:24.8.3"
dependencies:
chalk: "npm:^5.3.0"
dayjs: "npm:^1.11.11"
Expand All @@ -945,7 +945,7 @@ __metadata:
dependenciesMeta:
redis:
optional: true
checksum: 10/d45c39883df79ed85e1245bce833db9147d8749282e985ab0258e77989e2cf1dd6ebe62a6f8e2018ba1c5d9890b60bf03515a4d8f0b220229185a4790cbde9db
checksum: 10/016fc0859438a36c211958fb9b128d945a2535657ac3af7a543d4871689e3c71d2dc17f928c92172344f322cdd617cce9a7f77201fc8a1af27d0f097257b1dec
languageName: node
linkType: hard

Expand All @@ -954,7 +954,7 @@ __metadata:
resolution: "@digital-alchemy/mqtt-extension@workspace:."
dependencies:
"@cspell/eslint-plugin": "npm:^8.7.0"
"@digital-alchemy/core": "npm:^24.7.2"
"@digital-alchemy/core": "npm:^24.8.3"
"@types/figlet": "npm:^1.5.8"
"@types/jest": "npm:^29.5.12"
"@types/js-yaml": "npm:^4.0.9"
Expand Down

0 comments on commit e8a8508

Please sign in to comment.