Merge pull request #13 from diabolical-ninja/update-docs

Update Docs
diabolical-ninja · Jun 8, 2022 · 9755f21 · 9755f21
2 parents ad7027d + 240023d
commit 9755f21
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 3 deletions.
diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
@@ -7,6 +7,6 @@ jobs:
   draft_release:
     runs-on: ubuntu-latest
     steps:
-      - uses: release-drafter/release-drafter@v5.20
+      - uses: release-drafter/release-drafter@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
 
 [![Documentation Status](https://readthedocs.org/projects/nbnpy/badge/?version=latest)](https://nbnpy.readthedocs.io/en/latest/?badge=latest)
 
-
+<br/>
 
 This package provides an unofficial wrapper of the National Broadband Network's (NBN) API. It allows you to programatically lookup address's and examine connection details such as the connection type (FTTP, HFC, etc), service type, connection status and more.
 <br/><br/>
@@ -24,7 +24,7 @@ This package provides an unofficial wrapper of the National Broadband Network's
 Install `nbnpy` from the Python Package Index:
 
 ```console
-$ pip install nbn
+$ pip install nbnpy
 ```
 
 ## Requirements
@@ -50,6 +50,60 @@ location_info = nbn_client.location_information(location_id)
 pprint.pprint(location_info)
 ```
 
+<details>
+  <summary>Location Info Output</summary>
+
+  ```json
+  {
+        "addressDetail": {
+            "TC2SME": true,
+            "address1": "Unit 1 32 Flinders St",
+            "address2": "Melbourne VIC 3000 Australia",
+            "altReasonCode": "NULL_NA",
+            "cbdpricing": true,
+            "coatChangeReason": "",
+            "disconnectionDate": "Sep 2020",
+            "disconnectionStatus": "PAST",
+            "ee": true,
+            "eec": 1,
+            "formattedAddress": "UNIT 1 32 FLINDERS ST MELBOURNE VIC 3000 Australia",
+            "frustrated": false,
+            "id": "LOC000175010671",
+            "latitude": -37.81540657,
+            "longitude": 144.97344433,
+            "reasonCode": "FTTC_SA",
+            "serviceStatus": "available",
+            "serviceType": "Fixed line",
+            "speedTierAvailability": true,
+            "techFlip": "",
+            "techType": "FTTC",
+            "wp1DisconnectionDate": "11 September 2020",
+            "wp1DisconnectionStatus": "PAST",
+            "wp2DisconnectionDate": "11 September 2020",
+            "wp2DisconnectionStatus": "PAST",
+            "wp3DisconnectionDate": "11 September 2020",
+            "wp3DisconnectionStatus": "PAST",
+            "wp4DisconnectionDate": "11 September 2020",
+            "wp4DisconnectionStatus": "PAST",
+            "zeroBuildCost": true
+        },
+        "servingArea": {
+            "csaId": "CSA300000010316",
+            "description": "Exhibition",
+            "rfsMessage": "Sep 2018",
+            "serviceCategory": "brownfields",
+            "serviceStatus": "available",
+            "serviceType": "Fixed line",
+            "techType": "FTTC"
+        },
+        "timestamp": 1654656817504
+    }  
+  ```
+</details>
+
+
+
+
 ## Building the Project
 
 This package uses `poetry` and `nox` for package management and building. 

diff --git a/docs/conf.py b/docs/conf.py
@@ -8,6 +8,8 @@
 language = "en"
 html_theme = "furo"
 autodoc_typehints = "description"
+pygments_style = "sphinx"
+pygments_dark_style = "monokai"
 
 
 extensions = [