Skip to content

Commit 1c1dd7a

Browse files
committed
Updated docs
1 parent 60dedc4 commit 1c1dd7a

File tree

3 files changed

+12
-21
lines changed

3 files changed

+12
-21
lines changed

DOCUMENTATION.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ BrokerBin API wrapper for Node.js
88
#### Params
99

1010
- **Object** `auth`: An object containing the following data:
11-
- `username` (String): The BrokerBin username.
12-
- `password` (String): The BrokerBin password.
13-
- `soap_key` (String): The BrokerBin soap key.
14-
- `soap_uri` (String): The BrokerBin soap uri.
15-
- `public_key` (String): The BrokerBin public key.
11+
- `username` (String): The BrokerBin username (or ENV variable: `BROKERBIN_USERNAME`)
12+
- `password` (String): The BrokerBin password (or ENV variable: `BROKERBIN_PASSWORD`)
13+
- `soap_key` (String): The BrokerBin soap key (or ENV variable: `BROKERBIN_SOAP_KEY`)
14+
- `soap_uri` (String): The BrokerBin soap uri (or ENV variable: `BROKERBIN_SOAP_URI`)
15+
- `public_key` (String): The BrokerBin public key (or ENV variable: `BROKERBIN_PUBLIC_KEY`)
1616

1717
#### Return
1818
- **Number** Return description.

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2021 Bloggify <[email protected]> (https://bloggify.org)
3+
Copyright (c) 2021-22 Bloggify <[email protected]> (https://bloggify.org)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

+6-15
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,7 @@ const BrokerBin = require("brokerbin");
7777
(async () => {
7878

7979
// Initialize the BrokerBin
80-
const bbClient = new BrokerBin({
81-
username: process.env.BROKERBIN_USERNAME
82-
, password: process.env.BROKERBIN_PASSWORD
83-
, soap_key: process.env.BROKERBIN_SOAP_KEY
84-
, soap_uri: process.env.BROKERBIN_SOAP_URI
85-
, public_key: process.env.BROKERBIN_PUBLIC_KEY
86-
})
87-
88-
// Authenticate
89-
await bbClient.authenticate()
80+
const bbClient = new BrokerBin()
9081

9182
// Run a search
9283
const results = await bbClient.search("F238F", {
@@ -145,11 +136,11 @@ BrokerBin API wrapper for Node.js
145136
#### Params
146137

147138
- **Object** `auth`: An object containing the following data:
148-
- `username` (String): The BrokerBin username.
149-
- `password` (String): The BrokerBin password.
150-
- `soap_key` (String): The BrokerBin soap key.
151-
- `soap_uri` (String): The BrokerBin soap uri.
152-
- `public_key` (String): The BrokerBin public key.
139+
- `username` (String): The BrokerBin username (or ENV variable: `BROKERBIN_USERNAME`)
140+
- `password` (String): The BrokerBin password (or ENV variable: `BROKERBIN_PASSWORD`)
141+
- `soap_key` (String): The BrokerBin soap key (or ENV variable: `BROKERBIN_SOAP_KEY`)
142+
- `soap_uri` (String): The BrokerBin soap uri (or ENV variable: `BROKERBIN_SOAP_URI`)
143+
- `public_key` (String): The BrokerBin public key (or ENV variable: `BROKERBIN_PUBLIC_KEY`)
153144

154145
#### Return
155146
- **Number** Return description.

0 commit comments

Comments
 (0)