https://github.com/damianaldair/changelog_widgets

Flutter package to read 'CHANGELOG.md' file and display it in the app as a widget
https://github.com/damianaldair/changelog_widgets

changelog cupertino cupertino-design dart flutter material material-design widget widgets

Last synced: about 1 month ago
JSON representation

Flutter package to read 'CHANGELOG.md' file and display it in the app as a widget

• Host: GitHub
• URL: https://github.com/damianaldair/changelog_widgets
• Owner: DamianAldair
• License: mit
• Created: 2024-09-15T20:05:13.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-20T06:30:00.000Z (3 months ago)
• Last Synced: 2024-11-21T23:59:05.003Z (about 1 month ago)
• Topics: changelog, cupertino, cupertino-design, dart, flutter, material, material-design, widget, widgets
• Language: Dart
• Homepage: https://pub.dev/packages/changelog_widgets
• Size: 19.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Changelog Widgets

by [Damian Aldair](https://damianaldair.github.io).

---

Inspired by Flutter's **AboutDialog**.

The easiest way to display your app's changelog.

## Getting Started

Add following dependency to your `pubspec.yaml`.

```yaml

dependencies:

  changelog_widgets: 

```

## Initialization

Add the markdown file to your `pubspec.yaml`, in the **flutter** section, for example:

```dart

flutter:

  assets:

    - CHANGELOG.md

```

Import the package.

```dart

import 'package:changelog_widgets/changelog_widgets.dart';

```

Now, you can use the screens and dialogs.

## Available widgets

- Raw Material screen: `ChangelogRawScreen`.

- Built-in Material screen: `ChangelogScreen`.

- Built-in Material dialog: `ChangelogDialog`.

- Raw Cupertino screen: `CupertinoChangelogRawScreen`.

- Built-in Cupertino screen: `CupertinoChangelogScreen`.