Updated docs

Author: IonicaBizau

CONTRIBUTING.md

@@ -61,6 +61,6 @@ Thanks! :sweat_smile:
 
 
 
-[1]: https://github.com/IonicaBizau/brokerbin/issues
+[1]: https://github.com/Bloggify/brokerbin/issues
 
 [2]: https://github.com/IonicaBizau/code-style

DOCUMENTATION.md

@@ -2,16 +2,17 @@
 
 You can see below the API reference of this module.
 
-### `brokerbin(auth, {})`
+### `brokerbin(auth)`
 BrokerBin API wrapper for Node.js
 
 #### Params
 
 - **Object** `auth`: An object containing the following data:
    - `username` (String): The BrokerBin username.
    - `password` (String): The BrokerBin password.
-   - `soapkey` (String): The BrokerBin soap key.
-- **** `{}`: Param descrpition.
+   - `soap_key` (String): The BrokerBin soap key.
+   - `soap_uri` (String): The BrokerBin soap uri.
+   - `public_key` (String): The BrokerBin public key.
 
 #### Return
 - **Number** Return description.

README.md

@@ -72,18 +72,44 @@ yarn add brokerbin
 
 
 ```js
-const BrokerBin = require("brokerbin")
+const BrokerBin = require("brokerbin");
 
 (async () => {
-    const bbClient = new BrokerBin()
+
+    // Initialize the BrokerBin
+    const bbClient = new BrokerBin({
+        username: process.env.BROKERBIN_USERNAME
+      , password: process.env.BROKERBIN_PASSWORD
+      , soap_key: process.env.BROKERBIN_SOAP_KEY
+      , soap_uri: process.env.BROKERBIN_SOAP_URI
+      , public_key: process.env.BROKERBIN_PUBLIC_KEY
+    })
+
+    // Authenticate
     await bbClient.authenticate()
-    const results = await bbClient.search("...", {
+
+    // Run a search
+    const results = await bbClient.search("F238F", {
         max_resultset: 50
       , search_type: "partkey"
       , sort_order: "ASC"
       , sort_by: "price"
     })
+
+    // Output the result
     console.log(results)
+    // =>
+    // [ { company: '...',
+    //     country: 'GBR',
+    //     part: 'F238FNS',
+    //     mfg: 'DELL',
+    //     cond: 'REF',
+    //     price: '...',
+    //     qty: '4',
+    //     age: '0',
+    //     description: 'Dell 3.5" SAS Tray Caddy R710 R610 R410 T610 - No Screws',
+    //     clei: '',
+    //     status: '2' }, ... ]
 })()
 ```
 
@@ -113,16 +139,17 @@ There are few ways to get help:
 ## :memo: Documentation
 
 
-### `brokerbin(auth, {})`
+### `brokerbin(auth)`
 BrokerBin API wrapper for Node.js
 
 #### Params
 
 - **Object** `auth`: An object containing the following data:
    - `username` (String): The BrokerBin username.
    - `password` (String): The BrokerBin password.
-   - `soapkey` (String): The BrokerBin soap key.
-- **** `{}`: Param descrpition.
+   - `soap_key` (String): The BrokerBin soap key.
+   - `soap_uri` (String): The BrokerBin soap uri.
+   - `public_key` (String): The BrokerBin public key.
 
 #### Return
 - **Number** Return description.

package.json

@@ -44,4 +44,4 @@
     "phpunserialize": "^1.0.1",
     "soap": "^0.36.0"
   }
-}
+}