readability-dart/README.md
Sphericalkat f5aa107fac
fix(docs): add readme and changelog
Signed-off-by: Sphericalkat <me@kat.bio>
2024-07-18 02:02:02 +05:30

17 lines
592 B
Markdown

# readability
A flutter plugin that wraps the native Readability [library](https://github.com/go-shiori/go-readability) for Android and iOS.
## Usage
Simply call the `parseAsync` method with the URL of the article you want to parse. The method returns a `ArticleResult` object with the title, content, and excerpt of the article.
```dart
import 'package:readability/readability.dart';
final result = await Readability.parseAsync('https://example.com/article');
print(result.title);
print(result.content);
```
An example of how to use this plugin can be found in the `example` directory.