Readme Crypto Price Chart

Display live cryptocurrency price charts directly in the README.md file.

xychart-beta
  title "WETH-USDC"
  x-axis [Jun-1,Jun-15,Jul-1,Jul-15,Aug-1,Aug-15,Sep-1,Sep-15,Oct-1,Oct-15,Nov-1,Nov-15]
  y-axis "Closing Prices" 2320.61761915807 --> 3819.38075388494
  line [3819.38075388494,3563.50423684803,3435.37304391752,3482.40990196361,3205.99009674922,2575.67729986359,2425.60361929393,2320.61761915807,2447.67403957906,2600.26757373328,2508.72962693621,3064.05502969668]

Loading

How it works

This project uses a GitHub Actions workflow to periodically fetch the latest cryptocurrency prices from CoinGecko's public DEX APIs. The data is processed and used to update this README.md file, rendering a chart with the latest information using mermaid.js.

The workflow is defined in the main.yml file, located in the .github/workflows directory. It runs on a schedule, specified using cron syntax, and updates the chart data between the <!-- CHART_START --> and <!-- CHART_END --> markers in the README.md file.

How to Set Up

To set up this project:

1. Clone the Repository: Clone this repository that includes the main.yml file in the .github/workflows directory.

2. Ensure Write Permissions: Grant the repository write permissions to update the README.md file. You can do this by navigating to the repository's Settings > Actions > General > Workflow permissions.

3. Customize Your Setup: You can modify various settings in the main.yml file, such as the cryptocurrency pair, chain, and update frequency.

4. Update Your README.md: Include the following markers in your README.md file where you want the chart to appear:

  <!-- CHART_START -->
    *Chart will be dynamically inserted here.*
  <!-- CHART_END -->

Yaml Configuration (main.yml)

The main.yml file contains the workflow configuration. Below is an example setup:

  on:
  schedule:
    - cron: '0 0 */1 * *' # Runs once every day

  jobs:
    update-readme:
      steps:
      - name: Fetch Chart data
        env: 
          TITLE: WETH/USDC # Title of the chart
          CHAIN: eth # Chain - eth/bsc/polygon_pos/avax/movr/cro/one/boba/ftm/bch, check entire list: https://api.geckoterminal.com/api/v2/networks
          POOL: '0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640' # Pool pair address
          TIMEFRAME: day # Timeframe - day/hour/minute
          AGGREGATE: 1 # Aggregate options - day: [1], hour: [1, 4, 12] minute: [1, 5, 15]
          LIMIT: 365 # Limit - 100 to 1000, changing this may require modification to code below to fit the data

Contributions

Contributions are welcome! Please submit issues or pull requests with any improvements, new features, or bug fixes.

License

This project is licensed under the MIT License - see the LICENSE file for details.