README.md.tmpl 1.24 KB
Newer Older
1
<!--
2 3
This README describes the package. If you publish this package to pub.dev,
this README's contents appear on the landing page for your package.
4

5
For information about how to write a good package README, see the guide for
6
[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
7

8 9 10
For general information about developing packages, see the Dart guide for
[creating packages](https://dart.dev/guides/libraries/create-library-packages)
and the Flutter guide for
11
[developing packages and plugins](https://flutter.dev/developing-packages).
12
-->
13

14 15
TODO: Put a short description of the package here that helps potential users
know whether this package might be useful for them.
16

17 18 19 20 21 22 23 24 25 26 27 28
## Features

TODO: List what your package can do. Maybe include images, gifs, or videos.

## Getting started

TODO: List prerequisites and provide or point to information on how to
start using the package.

## Usage

TODO: Include short and useful examples for package users. Add longer examples
29
to `/example` folder.
30 31 32 33 34 35 36

```dart
const like = 'sample';
```

## Additional information

37 38
TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
39
from the package authors, and more.