docs: add funding links

eslint-functional · Jan 28, 2023 · 2078b50 · 2078b50
1 parent 97f94ac
commit 2078b50
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 4 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.1",
+  "version": "0.2",
   "language": "en",
   "ignorePaths": [
     "**/coverage/**",
@@ -21,16 +21,20 @@
     "misc",
     "filetypes"
   ],
+  "import": ["./node_modules/@cspell/dict-cryptocurrencies/cspell-ext.json"],
   "ignoreRegExpList": [
     "/```[\\w\\W]*?```/",
     "/~~~[\\w\\W]*?~~~/",
     "/``[\\w\\W]*?``/",
     "/`[^`]*`/",
     "/\\.\\/docs\\/rules\\/[^.]*.md/",
     "/TS[^\\s]+/",
-    "\\(#.+?\\)"
+    "\\(#.+?\\)",
+    "// @ts-.*",
+    "/[A-Za-z0-9]{32,}/"
   ],
   "words": [
+    "litecoin",
     "fleur",
     "globstar",
     "IIFE",

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+issuehunt: eslint-functional/eslint-plugin-functional
+ko_fi: rebeccastevens
+custom: https://github.com/eslint-functional/eslint-plugin-functional/blob/main/DONATIONS.md
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -58,6 +58,7 @@
     "allowed_elements": [
       "br",
       "div",
+      "img",
       "sub",
       "sup",
       "span",
@@ -87,7 +88,7 @@
   "MD043": false,
   // MD044/proper-names - Proper names should have the correct capitalization
   // "MD044": {
-  //   "names": ["JavaScript", "TypeScript", "TSLint", "ESLint"],
+  //   "names": ["JavaScript", "TypeScript"],
   //   "code_blocks": false
   // },
   // MD045/no-alt-text - Images should have alternate text (alt text)

diff --git a/DONATIONS.md b/DONATIONS.md
@@ -0,0 +1,33 @@
+# Donations
+
+Any donations would be much appreciated. 😄
+
+## Real money
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/rebeccastevens)
+
+## Cryptocurrencies
+
+<details>
+<summary><img src="https://raw.githubusercontent.com/get-icon/geticon/master/icons/bitcoin.svg" height="16"> Bitcoin</summary>
+
+![bitcoin address QR code](https://raw.githubusercontent.com/RebeccaStevens/RebeccaStevens/main/assets/cryptocurrencies/wallets/bitcoin.png)\
+bc1qgr2xwvkpztsaq9kplud84r3dfz4g3e7d5c5lxm
+
+</details>
+
+<details>
+<summary><img src="https://raw.githubusercontent.com/get-icon/geticon/master/icons/ethereum.svg" height="16"> Ethereum</summary>
+
+![ethereum address QR code](https://raw.githubusercontent.com/RebeccaStevens/RebeccaStevens/main/assets/cryptocurrencies/wallets/ethereum.png)\
+0x643769d1DD2Cb912656dAA27C1b97e5A81EF9fd2
+
+</details>
+
+<details>
+<summary><img src="https://raw.githubusercontent.com/RebeccaStevens/RebeccaStevens/main/assets/cryptocurrencies/logos/ltc.svg" height="16"> Litecoin</summary>
+
+![litecoin address QR code](https://raw.githubusercontent.com/RebeccaStevens/RebeccaStevens/main/assets/cryptocurrencies/wallets/litecoin.png)\
+ltc1qxr7p6z4hrh87g9mjjk67chyduwrh2nfrpxksjv
+
+</details>
diff --git a/README.md b/README.md
@@ -16,6 +16,10 @@ An [ESLint](http://eslint.org) plugin to disable mutation and promote functional
 
 </div>
 
+## Donate
+
+[Any donations would be much appreciated](./DONATIONS.md). 😄
+
 ## Rulesets
 
 The following rulesets are made available by this plugin:

diff --git a/package.json b/package.json
@@ -27,6 +27,12 @@
       "email": "rebecca.stevens@outlook.co.nz"
     }
   ],
+  "funding": [
+    {
+      "type": "ko-fi",
+      "url": "https://ko-fi.com/rebeccastevens"
+    }
+  ],
   "exports": {
     "default": "./lib/index.js",
     "import": "./lib/index.mjs",
@@ -72,6 +78,7 @@
     "@ava/typescript": "3.0.1",
     "@commitlint/cli": "17.4.2",
     "@commitlint/config-conventional": "17.4.2",
+    "@cspell/dict-cryptocurrencies": "3.0.1",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@rebeccastevens/eslint-config": "1.4.6",
     "@rollup/plugin-commonjs": "24.0.1",

diff --git a/yarn.lock b/yarn.lock
@@ -562,7 +562,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@cspell/dict-cryptocurrencies@npm:^3.0.1":
+"@cspell/dict-cryptocurrencies@npm:3.0.1, @cspell/dict-cryptocurrencies@npm:^3.0.1":
   version: 3.0.1
   resolution: "@cspell/dict-cryptocurrencies@npm:3.0.1"
   checksum: 5d646f569e8dc5998de8a508ff3de39db5f5a5db0a846ee4fc750ea3880080d922d5c28fdce38f93910eaacde2723e2fe4c305d50b3f9d53b817ce33a3bed66a
@@ -3314,6 +3314,7 @@ __metadata:
     "@ava/typescript": 3.0.1
     "@commitlint/cli": 17.4.2
     "@commitlint/config-conventional": 17.4.2
+    "@cspell/dict-cryptocurrencies": 3.0.1
     "@istanbuljs/nyc-config-typescript": 1.0.2
     "@rebeccastevens/eslint-config": 1.4.6
     "@rollup/plugin-commonjs": 24.0.1