diff --git a/README.md b/README.md index abc199e2..0e95a3f6 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,13 @@ In your `pubspec.yaml`: ```yaml dependencies: - angel_hot: ^1.0.0 + angel_framework: ^2.0.0-alpha + angel_hot: ^2.0.0 ``` # Usage This package is dependent on the Dart VM service, so you *must* run -Dart with the `--enable-vm-service` argument!!! +Dart with the `--observe` (or `--enable-vm-service`) argument!!! Usage is fairly simple. Pass a function that creates an `Angel` server, along with a collection of paths to watch, to the `HotReloader` constructor. The rest is history!!! @@ -26,7 +27,8 @@ to watch, to the `HotReloader` constructor. The rest is history!!! The recommended pattern is to only use hot-reloading in your application entry point. Create your `Angel` instance within a separate function, conventionally named `createServer`. -**Using this in production mode is pointless.** +**Using this in production mode is not recommended, unless you are +specifically intending for a "hot code push" in production..** You can watch: * Files @@ -39,8 +41,6 @@ You can watch: import 'dart:async'; import 'dart:convert'; import 'dart:io'; -import 'package:angel_compress/angel_compress.dart'; -import 'package:angel_diagnostics/angel_diagnostics.dart'; import 'package:angel_framework/angel_framework.dart'; import 'package:angel_hot/angel_hot.dart'; import 'src/foo.dart'; @@ -56,28 +56,23 @@ main() async { Uri.parse('package:angel_hot/angel_hot.dart') ]); - var server = await hot.startServer(InternetAddress.LOOPBACK_IP_V4, 3000); + var server = await hot.startServer('127.0.0.1', 3000); print( 'Hot server listening at http://${server.address.address}:${server.port}'); } Future createServer() async { var app = new Angel(); + ..injectSerializer(JSON.encode); - app.lazyParseBodies = true; - app.injectSerializer(JSON.encode); - - app.get('/', {'hello': 'hot world!'}); + app.get('/', (req, res) => {'hello': 'hot world!'}); app.post('/foo/bar', (req, res) async { var result = await someLengthyOperation(); return {'status': result}; }); - app.after.add(() => throw new AngelHttpException.notFound()); - - app.responseFinalizers.add(gzip()); - await app.configure(logRequests()); + app.fallback((req, res) => throw new AngelHttpException.notFound()); return app; } -``` \ No newline at end of file +```