Merge pull request #133 from pixlise/development

Release 3.0.0 #major

Author: pnemere

.github/workflows/bump-version.yml

@@ -22,14 +22,14 @@ jobs:
         #   triggering subsequent actions (like the Core Release workflow); to
         #   allow these tags to dispatch new workflows, you must pass in a PAT
         #   see: https://docs.github.com/en/actions/using-workflows/triggering-a-workflow#triggering-a-workflow-from-a-workflow
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.PIXLISE_GH_PAT }}
         WITH_V: true
         DEFAULT_BUMP: minor
     - name: Github Tag Bump
       if: github.event.pull_request.base.ref == 'development'
       uses: anothrNick/github-tag-action@1.61.0
       env:
         # NOTE: see above
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.PIXLISE_GH_PAT }}
         WITH_V: true
         DEFAULT_BUMP: patch

README.md

@@ -81,6 +81,11 @@ The API takes a few seconds to start up. Watch the Debug Console in VS Code! You
 - A listing of all API endpoints and what permission they require
 - `"INFO: API Started..."` signifying the API is ready to accept requests
 
+## Local Mongo database access
+
+Download "MongoDB Compass" and when the docker container is running locally (in docker), connect to it with this connection string:
+`mongodb://mongoadmin:secret@localhost:27888/?authMechanism=DEFAULT`
+
 ### Example CLI flags
 
 `-quantExecutor docker` - this tells the API to use local docker as the quant executor, meaning PIQUANT jobs will start on your local development machine.