Report Bug · Request Feature

1. You need to update the markdown file(.md) with 2 comments. You can refer here for updating it.
2. You'll need a GitHub API Token with repo and user scope from here

   enabling the repo scope seems DANGEROUS
   but this GitHub Action only will allow committing the updated readme.

   • You can use this example to work it out
3. You need to save the GitHub API Token in the repository secrets. You can find that in the Settings of your repository. Be sure to save those as the following.
   • GitHub Personal Access Token as GH_TOKEN=<your github access token>
4. You can enable and disable feature flags based on requirements here. The only required flag is the GitHub API token.

This Action is best run on every push but dont worry it will only commit when colours are updated.

Add a comment to your README.md like this:

<!--START_SECTION:wordcloud-->
<!--END_SECTION:wordcloud-->

These lines will be our entry-points for where the wordcloud will be placed. An example can be seen here.

You'll need to get a GitHub Access Token with a repo and user scope and save it in the Repo Secrets GH_TOKEN = <Your GitHub Access Token>

Here is Sample Workflow File for running it:

name: WordCloud

# everday at 00:00 UTC.
on: 
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * *'

jobs:
  update-readme:
    name: Update Readme with WordCloud
    runs-on: ubuntu-latest
    steps:
      - uses: Parply/profile-wordcloud@master
        with:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}

If you want to ignore certain file or repos or other options, you can add multiple FLAGS in your workflow file.

- uses: Parply/readme-badge-colouriser@master
      with:
        GH_TOKEN: ${{ secrets.GH_TOKEN }}
        CMAP: "flag"
        AUTHOR: "Parply"

• IGNORE_FILE_TYPES Comma seperated string of file types to ignore. Defaults to ".pdf,.o,.csv"

• IGNORE_REPOS Comma seperated string of repositories to ignore. Defaults to ""

• WIDTH Width to set image. Defaults to "100%"

• CMAP Colourmap to use for colouring words. Uses matplotlib's colormaps. Defaults to "hsv"

• AUTHOR Name of the author committing to the readme. Defaults to wordcloud bot

• BRANCH Branch to commit to. Defaults to master

Made with Python 🐍.