Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -38,7 +56,7 @@ jobs:

ci:
name: Checks
needs: [checks]
needs: [conventional-commit, checks]
runs-on: ubuntu-latest
if: always()
steps:
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
Loading