| Index: lib/resource.dart
|
| diff --git a/lib/resource.dart b/lib/resource.dart
|
| index b23d220637065e1ddbbcf0283b3c1f50c03a4ad1..83c75c695dabd9249317861ec15cbf8691c36cb8 100644
|
| --- a/lib/resource.dart
|
| +++ b/lib/resource.dart
|
| @@ -2,9 +2,27 @@
|
| // for details. All rights reserved. Use of this source code is governed by a
|
| // BSD-style license that can be found in the LICENSE file.
|
|
|
| -/// A [Resource] is data that can be loaded into a Dart program.
|
| +/// A [Resource] is data that can be read into a Dart program.
|
| ///
|
| -/// A resource is identified by a URI.
|
| +/// A resource is identified by a URI. It can be loaded as bytes or data.
|
| +/// The resource URI may be a `package:` URI.
|
| +///
|
| +/// Example:
|
| +///
|
| +/// var resource = new Resource("package:foo/foo_data.txt");
|
| +/// var string = await resource.readAsString(UTF8);
|
| +/// print(string);
|
| +///
|
| +/// Example:
|
| +///
|
| +/// var resource = new Resource("http://example.com/data.json");
|
| +/// var obj = await resource.openRead() // Reads as stream of bytes.
|
| +/// .transform(UTF8.fuse(JSON).decoder)
|
| +/// .first;
|
| +///
|
| +///
|
| +/// Notice: Currently this package requires `dart:io` to do the reading,
|
| +/// so it doesn't work in the browser.
|
| library resource;
|
|
|
| export "src/resource.dart" show Resource;
|
|
|