Skip to content

Commit

Permalink
added a readme plus actions (#1)
Browse files Browse the repository at this point in the history
* added a readme plus actions

* Fix readme

* final
  • Loading branch information
zippy1981 committed Jan 6, 2024
1 parent 4cf47be commit cb8a823
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/readme.yml
@@ -0,0 +1,22 @@
name: Lint README.md

on:
push:
paths:
- 'README.md' # Trigger only when README.md is modified
branches: [main] # Trigger on pushes to the main branch
pull_request:
paths:
- 'README.md' # Trigger only when README.md is modified
branches: [main] # Also trigger on pull requests to main

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3 # Checkout the repository
- uses: actions/setup-node@v3
with:
node-version: 16 # Use Node.js version 16
- run: npm install -g markdownlint-cli # Install markdownlint-cli
- run: markdownlint README.md # Lint the README.md file
9 changes: 9 additions & 0 deletions README.md
@@ -0,0 +1,9 @@
# Mastadon utils

Some mastadon utilities I wrote

## Latest build statuses

| Workflow | Status |
|---|:---|
| Lint README.md | ![Lint README.md status badge](https://github.com/USERNAME/REPOSITORY/actions/workflows/readme.yml/badge.svg) |

0 comments on commit cb8a823

Please sign in to comment.