shields

Generates shields to be added to your readme

Installation

pubspec.yaml:

dependencies:
  shields: ^1.0.3

or

pub global activate shields

Example

import 'package:shields/shields.dart';

void main(List<String> args) async {
  final props = await ShieldProps.read();
  print(compileShields(props));
}

from terminal

shields

Env config

To avoid shields command querying you each time, export this variables

export GITHUB_USERNAME=<ghusername>
export SHIELDS_HOST=<yoursite.com>
export TWITTER_USERNAME=<yourtwitterhandle>

License

MIT