readme 1.0.0
readme: ^1.0.0

Flutter Android iOS

Generates a readme for flutter package

readme #

lesnitsky.dev GitHub stars Twitter Follow

Generates a readme for flutter package

Installation #

pubspec.yaml:

dependencies:
  readme: ^1.0.0

or

pub global activate readme

Example #

import 'dart:io';

import 'package:readme/readme.dart';

void main(List<String> args) async {
  final info = getPackageInfo();

  final shiledProps = await ShieldProps.read();

  final readme = new Readme()
    ..packageName = info.name
    ..description = info.description
    ..license = args.length > 0 ? args.first : 'MIT'
    ..example = await getExample()
    ..shields = compileShields(shiledProps);

  stdout.write(readme);
}

From command line

readme <LICENSE_TYPE> # default: MIT

License #

MIT

1
likes
80
pub points
15%
popularity

Publisher

lesnitsky.dev

Generates a readme for flutter package

Repository (GitHub)
View/report issues

Documentation

API reference

License

unknown (LICENSE)

Dependencies

flutter, fs_extensions, l_cli, license, shields, tmpl, yaml

More

Packages that depend on readme