|
1 | | -# blocs |
| 1 | +<!-- |
| 2 | +This README describes the package. If you publish this package to pub.dev, |
| 3 | +this README's contents appear on the landing page for your package. |
2 | 4 |
|
3 | | -A library for Dart developers. |
| 5 | +For information about how to write a good package README, see the guide for |
| 6 | +[writing package pages](https://dart.dev/tools/pub/writing-package-pages). |
4 | 7 |
|
5 | | -Created from templates made available by Stagehand under a BSD-style |
6 | | -[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE). |
| 8 | +For general information about developing packages, see the Dart guide for |
| 9 | +[creating packages](https://dart.dev/guides/libraries/create-packages) |
| 10 | +and the Flutter guide for |
| 11 | +[developing packages and plugins](https://flutter.dev/to/develop-packages). |
| 12 | +--> |
7 | 13 |
|
8 | | -## Usage |
| 14 | +TODO: Put a short description of the package here that helps potential users |
| 15 | +know whether this package might be useful for them. |
| 16 | + |
| 17 | +## Features |
| 18 | + |
| 19 | +TODO: List what your package can do. Maybe include images, gifs, or videos. |
9 | 20 |
|
10 | | -A simple usage example: |
| 21 | +## Getting started |
11 | 22 |
|
12 | | - import 'package:simple_blocs/blocs.dart'; |
| 23 | +TODO: List prerequisites and provide or point to information on how to |
| 24 | +start using the package. |
| 25 | + |
| 26 | +## Usage |
13 | 27 |
|
14 | | - main() { |
15 | | - var awesome = new Awesome(); |
16 | | - } |
| 28 | +TODO: Include short and useful examples for package users. Add longer examples |
| 29 | +to `/example` folder. |
17 | 30 |
|
18 | | -## Features and bugs |
| 31 | +```dart |
| 32 | +const like = 'sample'; |
| 33 | +``` |
19 | 34 |
|
20 | | -Please file feature requests and bugs at the [issue tracker][tracker]. |
| 35 | +## Additional information |
21 | 36 |
|
22 | | -[tracker]: http://example.com/issues/replaceme |
| 37 | +TODO: Tell users more about the package: where to find more information, how to |
| 38 | +contribute to the package, how to file issues, what response they can expect |
| 39 | +from the package authors, and more. |
0 commit comments