https://github.com/akosbalasko/coffee-readme

Coffee-readme updates your repository's readme with messages from your last X Buy-Me-A-Coffee supporters
https://github.com/akosbalasko/coffee-readme

buy-me-a-coffee buymeacoffee buymecoffee github-action readme readme-generator

Last synced: 7 days ago
JSON representation

Coffee-readme updates your repository's readme with messages from your last X Buy-Me-A-Coffee supporters

• Host: GitHub
• URL: https://github.com/akosbalasko/coffee-readme
• Owner: akosbalasko
• License: mit
• Created: 2022-03-14T13:12:42.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-23T18:32:08.000Z (almost 3 years ago)
• Last Synced: 2024-05-21T03:54:13.060Z (7 months ago)
• Topics: buy-me-a-coffee, buymeacoffee, buymecoffee, github-action, readme, readme-generator
• Homepage:
• Size: 1.36 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        

# Buy Me A Coffee Donations and Messages on your Readme page

## It will look like this:

![./assets/buy-me-a-coffee-outfit.png](./assets/buy-me-a-coffee-outfit.png)

## Prerequisites

In order to set this action, you need to have the followings:

1. A Buy-Me-A-Coffee token

2. A github token (it will be generated automatically)

## Setup

1. Edit your README.md file and add two lines as follows: 

```md

```

These lines won't be shown in the generated Readme file (because they are comments in HTML), but they will specify the concrete place where the list of the latest donations should be inserted. Please note that anything between these two lines will be removed by the newly generated list when the action is triggered.

2. Create a Token in [Buy Me A Coffee developer page](https://developers.buymeacoffee.com/dashboard)

- 2.1 Login to the Developers page

- 2.2 Click to create new Token

- 2.3 Name your token and click to Create

- 2.4 Copy the code generated (your token) to the clipboard

3. Set the Buy Me A Coffee Token as a github Secret

- 3.1 Navigate to the repository in where you would like to use this action

- 3.2 Go to Settings and then click to Secrets/Actions at the left menu

- 3.3 Click to 'New repository Secret' button

- 3.4 Name the secret exactly `BUY_ME_A_COFFEE_TOKEN`

- 3.5 Paste your Buy Me A Coffee Token from your clipboard and then Save. You should see something like this: 

  

4. Set a workflow in your repository by following the next steps:

- 4.1 Go to your project's `actions`, hit `New workflow` and `set up a workflow yourself`, then delete all the default content.

- 4.2 Copy-Paste the code below to your new workflow file and save/commit it as `buy-me-a-coffee.yml`.

   ```yml

   name: Buy Me A Coffee Readme

   on:

     workflow_dispatch:

     schedule:

       # Runs at every 12AM UTC

       - cron: "0 0 * * *"

   jobs:

     bmac-readme:

       name: Update Buy Me A Coffee section in this repo's README

       runs-on: ubuntu-latest

       steps:

         - uses: akosbalasko/coffee-readme@main

           with:

             BUY_ME_A_COFFEE_TOKEN: ${{ secrets.BUY_ME_A_COFFEE_TOKEN }}

             GH_TOKEN: ${{secrets.GITHUB_TOKEN }}

   ```

### Extra Options

- You can specify the number of the messages to be added into the readby by setting `NUMBER_OF_MESSAGES` property. By default it is 3.

- You can specify the branch in where the readme should be pushed by setting `BRANCH` property. Default is `main`.

## Enjoy! 

PS.: Like what you see? Consider to ! :)