Merge pull request #870 from CookieMonsterTeam/dev

Master to 2.031.9

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/publish-dev.yml

@@ -0,0 +1,16 @@
+name: Publish
+on:
+  push:
+    branches:
+      - "dev"
+jobs:
+  publish-dev:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: everlytic/[email protected]
+        with:
+          github_token: ${{ github.token }}
+          source_ref: 'dev'
+          target_branch: 'gh-pages'
+          commit_message_template: '[Automated] Merge {source_ref} into {target_branch}'

.mocharc.json

@@ -1,5 +1,4 @@
 {
   "recursive": true,
-  "require": ["esm", "ts-node/register"],
-  "reporter": "min"
+  "require": ["esm", "ts-node/register"]
 }

README.md

@@ -1,4 +1,4 @@
-![ESLint](https://github.com/Aktanusa/CookieMonster/workflows/ESLint/badge.svg?event=push)
+[![CI](https://github.com/CookieMonsterTeam/CookieMonster/actions/workflows/CI.yml/badge.svg)](https://github.com/CookieMonsterTeam/CookieMonster/actions/workflows/CI.yml)
 ## Cookie Monster
 
 **Cookie Monster** is an addon you can load into Cookie Clicker, that offers a wide range of tools and statistics to enhance the game. **It is not a cheat interface** – although it does offer helpers for golden cookies and such, everything can be toggled off at will to only leave how much information you want.
@@ -19,8 +19,9 @@ max(cost - cookies in bank, 0)/cps + cost/Δ cps
 
 If the relevant option is enabled, CM will color-code each of them based on their value. CM compares the PP across all possible buy options: if a buy 10 option is better than any of the buy 1 options Cookie Monster will colour them accordingly. Note that sometimes it is better to buy 10 of a building than to buy only 1, CM will also indicate this!
 
-The following standard colours are used:
-
+<details>
+  <summary>The following standard colours are used:</summary>
+
 * Light Blue: (upgrades) This item has a better PP than the best building to buy
 * Green: This building has the best PP
 * Yellow: This building is within the top 10 of best PP's
@@ -29,6 +30,8 @@ The following standard colours are used:
 * Purple: This building is worse than the top 10 of best PP's
 * Gray: This item does not have a PP, often this means that there is no change to CPS
 
+</details>
+
 Note: For this index, **lower is better**, meaning a building with a PP of 1 is more interesting than one with a PP of 3.
 
 ## Using
@@ -59,6 +62,12 @@ Before submitting a bug, make sure to give a shot at the latest version of the a
 
 All suggestions are welcome, even the smallest ones.
 
+## For developers
+
+Cookie Monster exposes some of the data it creates to the global scope. This data can be found in the `CookieMonsterData` object after loading Cookie Monster.
+
+Currently we exposes relevant data for buildings and upgrades (PP, colour and bonus income). If you would like us to add any aditional data, please feel free to open an issue or create a PR doing so!
+
 ## Contributing
 
 To contribute you can fork and clone the repository and run `npm install`.