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

Libraries

get_example
get_package_info
readme