Deprecate (#49) Deprecate the package.
diff --git a/CHANGELOG.md b/CHANGELOG.md index dec400e..4916fa6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md
@@ -1,3 +1,8 @@ +## 2.1.7 +- **This package is discontinued**. + The package is not going to be maintained or upgraded in the future. + See the `README.md` for more information. + ## 2.1.6 - Cast stream to `List<int>` in 'readAsString', this is in preparation for `HttpClientResponse` implementing `Stream<Uint8List>` (forward compatible
diff --git a/README.md b/README.md index e65003b..2f1bb98 100644 --- a/README.md +++ b/README.md
@@ -1,5 +1,33 @@ # Resource +---- +**NOTICE** This package is **discontinued**. +It will not be maintained or upgraded in the future. + +This package combines two functionalities: +* Converting a `package:` URI to a platform specific URI + (usually `http:` or `file:`, depending on the platform) +* Load the contents of such platform specific URIs. + +The former no longer makes sense when a large number of Dart +programs are ahead-of-time compiled. +Those programs do not have access to *source* files at runtime, +and a `package:` URI references a source file. +There is no standard way to find a *runtime* location of a source file, +or even ensure that it is available. + +The platform specific loading functionality can still be useful. +However, without a way to produce such platform specific URIs from +platform independent ones, the only URIs which can still +be loaded on all platforms are `http:`/`https:` ones. +Loading those is *better* supported by the [`http` package][package:http]. + +As such, this package can no longer supports its original goal, +being a *cross platform* resource loading solution. +It will be discontinued rather than provide an inadequate solution. + +---- + Reading data from package contents and files. A resource is data that can be read into a Dart program at runtime. @@ -28,3 +56,4 @@ Please file feature requests and bugs at the [issue tracker][tracker]. [tracker]: https://github.com/dart-lang/resource/issues +[package:http]: https://pub.dartlang.org/packages/http
diff --git a/lib/resource.dart b/lib/resource.dart index 860de6c..dba0fe3 100644 --- a/lib/resource.dart +++ b/lib/resource.dart
@@ -2,6 +2,35 @@ // 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. +/// **NOTICE** This package is **discontinued**. +/// It will not be maintained or upgraded in the future. +/// +/// This package combines two functionalities: +/// * Converting a `package:` URI to a platform specific URI +/// (usually `http:` or `file:`, depending on the platform) +/// * Load the contents of such platform specific URIs. +/// +/// The former no longer makes sense when a large number of Dart +/// programs are ahead-of-time compiled. +/// Those programs do not have access to *source* files at runtime, +/// and a `package:` URI references a source file. +/// There is no standard way to find a *runtime* location of a source file, +/// or even ensure that it is available. +/// +/// The platform specific loading functionality can still be useful. +/// However, without a way to produce such platform specific URIs from +/// platform independent ones, the only URIs which can still +/// be loaded on all platforms are `http:`/`https:` ones. +/// Loading those is *better* supported by the [`http` package][package:http]. +/// +/// As such, this package can no longer supports its original goal, +/// being a *cross platform* resource loading solution. +/// It will be discontinued rather than provide an inadequate solution. +/// +/// [package:http]: https://pub.dartlang.org/packages/http +/// +/// ---- +/// /// A `Resource` is data that can be read into a Dart program. /// /// A resource is identified by a URI. It can be loaded as bytes or data. @@ -19,6 +48,8 @@ /// var obj = await resource.openRead() // Reads as stream of bytes. /// .transform(utf8.fuse(JSON).decoder) /// .first; +@Deprecated('This package has been discontinued.' + ' See library documentation of README.md for more infomration') library resource; export 'src/resource.dart' show Resource;
diff --git a/pubspec.yaml b/pubspec.yaml index 378ea2b..f683c50 100644 --- a/pubspec.yaml +++ b/pubspec.yaml
@@ -1,5 +1,5 @@ name: resource -version: 2.1.7-dev +version: 2.1.7 description: Reading resource data from (package and other) files. homepage: https://github.com/dart-lang/resource