docs: add config-environment note

jacobsvante · Oct 29, 2023 · 378f8e5 · 378f8e5
1 parent 14a04d2
commit 378f8e5
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,9 @@
-# netsuite
+---
+hide:
+- navigation
+---
+
+# netsuite python library
 
 Make async requests to NetSuite SuiteTalk SOAP/REST Web Services and Restlets
 
@@ -78,6 +83,18 @@ You can add multiple sections like this. The `netsuite` section will be read by
 
 The default location that will be read is `~/.config/netsuite.ini`. This can overriden with the `-p` flag.
 
+Alternatively, you can source configuration from your environment variables instead (pairs well with [direnv](https://direnv.net)):
+
+```shell
+export NETSUITE_ACCOUNT=DIGITS_SB1
+export NETSUITE_CONSUMER_KEY=LONGALPHANUMERIC
+export NETSUITE_CONSUMER_SECRET=LONGALPHANUMERIC
+export NETSUITE_TOKEN_ID=LONGALPHANUMERIC
+export NETSUITE_TOKEN_SECRET=LONGALPHANUMERIC
+```
+
+And using the `--config-environment` flag when loading the CLI.
+
 Append `--help` to the commands to see full documentation.
 
 ### `rest-api` - Make requests to NetSuite REST API

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,4 @@
 site_name: netsuite
+repo_name: jacobsvante/netsuite
 theme:
   name: material
-  github_url: "https://github.com/jacobsvante/netsuite"