Merge pull request #21 from tiagosiebler/readmeUpdate

chore(): update readme

Author: tiagosiebler

.github/workflows/templates-readme.yml

@@ -0,0 +1,89 @@
+name: Update README.md templates
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: write # Grant write permissions to the contents
+
+env:
+  FILE_NAME: README.md
+
+jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          registry-url: https://registry.npmjs.org/
+          cache: 'npm'
+
+      - name: Install
+        run: npm ci --ignore-scripts
+
+      - name: Get the current date and time
+        id: datetime
+        run: echo "BRANCH_NAME=$(date +'actions_templates_%Y_%m_%d_%H%M%S')" >> $GITHUB_ENV
+
+      - name: Create update-template.sh script
+        run: |
+          cat << 'EOF' > update-template.sh
+          #!/bin/bash
+
+          TEMPLATE_VALUE=$(curl -s $TEMPLATE_URL)
+
+          perl -0777 -i -pe "
+          my \$tag = quotemeta('<!-- template_${TEMPLATE_TAG} -->');
+          my \$end_tag = quotemeta('<!-- template_${TEMPLATE_TAG}_end -->');
+          my \$replacement = '${TEMPLATE_VALUE}';
+
+          # Match the tag, then any amount of whitespace (including newlines), then the replacement, then any amount of whitespace, then the end tag.
+          s/(\$tag)(\s*)(.*?)(\s*)(\$end_tag)/\$1\n\$replacement\n\$5/s;
+          " "$FILE_NAME"
+
+          EOF
+          chmod +x update-template.sh
+          cat update-template.sh
+
+      - name: Fetch and update RELATED PROJECTS template
+        run: ./update-template.sh
+        env:
+          TEMPLATE_URL: https://raw.githubusercontent.com/wiki/tiagosiebler/awesome-crypto-examples/Related-projects.md
+          TEMPLATE_TAG: related_projects
+
+      - name: Fetch and update CONTRIBUTIONS template
+        run: ./update-template.sh
+        env:
+          TEMPLATE_URL: https://raw.githubusercontent.com/wiki/tiagosiebler/awesome-crypto-examples/Contributions-%26-Thanks.md
+          TEMPLATE_TAG: contributions
+
+      - name: Fetch and update STAR HISTORY template
+        run: ./update-template.sh
+        env:
+          TEMPLATE_URL: https://raw.githubusercontent.com/wiki/tiagosiebler/awesome-crypto-examples/Star-History.md
+          TEMPLATE_TAG: star_history
+
+      - name: Check for changes before running linter
+        run: git diff
+
+      - name: Check for changes | PR URL HERE
+        id: commitIfChanged
+        run: |
+          npx prettier -w README.md
+          if git diff --quiet; then
+            echo "No changes to commit"
+            exit 0
+          fi
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git checkout -b ${{ env.BRANCH_NAME }}
+          git add $FILE_NAME
+          git commit -m 'chore(): ${{ env.FILE_NAME }} template sections'
+          git push origin ${{ env.BRANCH_NAME }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,62 +1,62 @@
-# awesome-crypto-examples
+# Awesome crypto examples
+
+[![Build & Test](https://github.com/tiagosiebler/awesome-crypto-examples/actions/workflows/build.yml/badge.svg)](https://github.com/tiagosiebler/awesome-crypto-examples/actions/workflows/test.yml)
+[![last commit](https://img.shields.io/github/last-commit/tiagosiebler/awesome-crypto-examples)](https://github.com/tiagosiebler/awesome-crypto-examples)
+[![Telegram](https://img.shields.io/badge/chat-on%20telegram-blue.svg)](https://t.me/nodetraders)
 
 Wondering how to "[insert something crypto & nodejs related]"? Welcome to a loose collection of node.js examples and demos in the world of algo trading (especially cryptocurrencies).
 
 What kind of examples?
+
 - Working with crypto exchange REST APIs
 - Working with crypto exchange WebSocket streams
 - Anything else crypto + node.js?
 
 Note: these are not meant to suggest best practices. These are purely demonstrations for one (or more) way(s) for doing various things.
 
-## Related projects
-Check out my related projects:
-- Try my connectors:
-  - [binance](https://www.npmjs.com/package/binance)
-  - [bybit-api](https://www.npmjs.com/package/bybit-api)
-  - [okx-api](https://www.npmjs.com/package/okx-api)
-  - [bitget-api](https://www.npmjs.com/package/bitget-api)
-  - [ftx-api](https://www.npmjs.com/package/ftx-api)
-- Try my misc utilities:
-  - [orderbooks](https://www.npmjs.com/package/orderbooks)
-- Check out my examples:
-  - [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples)
-
 ## Getting started
+
 All examples are in node.js and/or typescript.
+
 - Ensure you have node.js installed (see `.nvmrc` for the recommended version (or above))
 - Install dependencies: `npm install`
 
 ### Frequenty Asked Questions
+
 Check out the wiki. Contributions welcome:
 https://github.com/tiagosiebler/awesome-crypto-examples/wiki
 
 ### Running examples (node.js)
 
 Node.js examples will be any file that ends with `.js`. If the example has a readme, refer to the readme for specific instructions, otherwise use the following command to run the example with node.js:
+
 ```bash
 node src/path/to/example.js
 ```
 
 ### Running examples (typescript)
 
 Typescript examples will be any file that ends with `.ts`. If the example has a readme, refer to the readme for specific instructions, otherwise use the following command to run the example with typescript's ts-node:
+
 ```bash
 npx ts-node src/path/to/example.ts
 ```
 
 Refer to the following documentation for guidance on ts-node: https://www.npmjs.com/package/ts-node#overview
 
 ### Providing API keys
+
 Some examples make private API calls (e.g. the [account monitoring](https://github.com/tiagosiebler/awesome-crypto-examples/blob/master/src/exchanges/binance/account-events/log-account-events.ts#L9-L10) ones). These rely on API credentials to make signed API calls to your account.
 
 Either locally download a copy of this repo and edit the values directly, or provide these as environmental variables. If a sample has the following process.env snippet:
+
 ```
 const key = process.env.APIKEY || 'APIKEY';
 const secret = process.env.APISECRET || 'APISECRET';
 ```
 
 You can provide your API credentials (in unix & macOS environments) when executing the sample:
+
 ```bash
 APIKEY="yourkeyhere" APISECRET="yoursecrethere" npx ts-node src/exchanges/binance/account-events/log-account-events.ts
 ```
@@ -71,3 +71,51 @@ PRs for various concepts welcome. Typescript preferred, but plain javascript is
   - If it's useful & reasonable for others to learn from, as big as you want!
 - Stuck on a problem and looking for a related sample?
   - Use the issues tab or join the [node.js algo traders telegram community](https://t.me/nodetraders)!
+
+<!-- template_contributions -->
+
+## Contributions & Thanks
+
+Have my projects helped you? Share the love, there are many ways you can show your thanks:
+
+- Star & share my projects.
+- Are my projects useful? Sponsor me on Github and support my effort to maintain & improve them: https://github.com/sponsors/tiagosiebler
+- Have an interesting project? Get in touch & invite me to it.
+- Or buy me all the coffee:
+  - ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` <!-- metamask -->
+
+<!-- template_contributions_end -->
+
+### Contributions & Pull Requests
+
+Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
+
+<!-- template_related_projects -->
+
+## Related projects
+
+Check out my related JavaScript/TypeScript/Node.js projects:
+
+- Try my REST API & WebSocket SDKs:
+  - [Bybit-api Node.js SDK](https://www.npmjs.com/package/bybit-api)
+  - [Okx-api Node.js SDK](https://www.npmjs.com/package/okx-api)
+  - [Binance Node.js SDK](https://www.npmjs.com/package/binance)
+  - [Gateio-api Node.js SDK](https://www.npmjs.com/package/gateio-api)
+  - [Bitget-api Node.js SDK](https://www.npmjs.com/package/bitget-api)
+  - [Kucoin-api Node.js SDK](https://www.npmjs.com/package/kucoin-api)
+  - [Coinbase-api Node.js SDK](https://www.npmjs.com/package/coinbase-api)
+  - [Bitmart-api Node.js SDK](https://www.npmjs.com/package/bitmart-api)
+- Try my misc utilities:
+  - [OrderBooks Node.js](https://www.npmjs.com/package/orderbooks)
+  - [Crypto Exchange Account State Cache](https://www.npmjs.com/package/accountstate)
+- Check out my examples:
+  - [awesome-crypto-examples Node.js](https://github.com/tiagosiebler/awesome-crypto-examples)
+  <!-- template_related_projects_end -->
+
+<!-- template_star_history -->
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=tiagosiebler/bybit-api,tiagosiebler/okx-api,tiagosiebler/binance,tiagosiebler/bitget-api,tiagosiebler/bitmart-api,tiagosiebler/gateio-api,tiagosiebler/kucoin-api,tiagosiebler/coinbase-api,tiagosiebler/orderbooks,tiagosiebler/accountstate,tiagosiebler/awesome-crypto-examples&type=Date)](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/okx-api&tiagosiebler/binance&tiagosiebler/bitget-api&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&tiagosiebler/kucoin-api&tiagosiebler/coinbase-api&tiagosiebler/orderbooks&tiagosiebler/accountstate&tiagosiebler/awesome-crypto-examples&Date)
+
+<!-- template_star_history_end -->

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "awesome-crypto-examples",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": true,
   "description": "Awesome crypto automation & algo trading examples",
   "main": "index.js",