diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0e51071..0381879 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -6,13 +6,31 @@ on: permissions: contents: read + pull-requests: read concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true jobs: + conventional-commit: + name: Conventional Commit + runs-on: ubuntu-latest + steps: + - uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5.5.3 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + types: | + feat + fix + docs + chore + deps + revert + checks: + needs: [conventional-commit] runs-on: ubuntu-latest strategy: fail-fast: false @@ -38,7 +56,7 @@ jobs: ci: name: Checks - needs: [checks] + needs: [conventional-commit, checks] runs-on: ubuntu-latest if: always() steps: diff --git a/README.md b/README.md index 4058b6f..47a40c5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # Readability +[![pub package](https://img.shields.io/pub/v/reader_mode.svg)](https://pub.dev/packages/reader_mode) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE) + A Dart port of [Mozilla's Readability.js](https://github.com/mozilla/readability) - extract readable content from any web page. ## Requirements @@ -14,7 +17,13 @@ Add to your `pubspec.yaml`: ```yaml dependencies: - reader_mode: ^0.1.0 + reader_mode: # see pub.dev for latest version +``` + +Or run: + +```bash +dart pub add reader_mode ``` ### As a CLI Tool