Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(607)

Unified Diff: pkg/http_server/README.md

Issue 113733002: move contents of readme into library docs (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: tweaks from review Created 7 years ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | pkg/http_server/lib/http_server.dart » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/http_server/README.md
diff --git a/pkg/http_server/README.md b/pkg/http_server/README.md
index 9d823862720a50ea2f99b39526a45841fcacd386..f0b90f4588a82cbcc2b428729560feec82438ce2 100644
--- a/pkg/http_server/README.md
+++ b/pkg/http_server/README.md
@@ -1,44 +1,19 @@
-Library of HTTP server classes.
+# http_server
This package contains a set of high-level classes that, together with
HttpServer, makes is easy to provide content through HTTP servers.
-## Virtual directory
+**NOTE:** This package currently only works for
+server-side or command-line Dart applications. In other words, if the app
+imports `dart:io`, it can use this package.
-The VirtualDirectory class makes it possible to easy serve static content from
-the drive. It supports:
+## Using
- * Range-based request, making it possible to pause/resume downloads and stream
- videos.
- * If-Modified-Since based caching.
- * Automatic GZip-compression of content.
- * Ability to follow links within, either throughout the system or in a jailed
- root.
- * Optional directory listing.
+Please see the [API docs][docs] for explanations and examples.
- The following example shows how to set up a Virtual Directory of a given path
+## Filing issues
- var virtualDirectory = new VirtualDirectory('/var/www/');
- virtualDirectory.serve(new HttpServer('0.0.0.0', 8080));
+Please file issues for the http package at [http://dartbug.com/new][bugs].
-See [VirtualDirectory](
-http://api.dartlang.org/docs/http_server/VirtualDirectory.html)
-for more info about how to customize the class.
-
-## Virtual host
-
-The VirtualHost class makes it possible to serve multiple hosts on the same
-address, by using the `Host` field of the incoming requests. It also provides
-the ability to work on wildcards for sub-domains.
-
- var virtualHost = new VirtualHost(server);
- // Filter out on a specific host
- var stream1 = virtualServer.addHost('static.myserver.com');
- // Wildcard for any other sub-domains.
- var stream2 = virtualServer.addHost('*.myserver.com');
- // Requets not matching any hosts.
- var stream3 = virtualServer.unhandled;
-
-See [VirtualHost](
-http://api.dartlang.org/docs/http_server/VirtualHost.html)
-for more information.
+[bugs]: http://dartbug.com/new
+[docs]: https://api.dartlang.org/docs/channels/stable/latest/http_server.html
« no previous file with comments | « no previous file | pkg/http_server/lib/http_server.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698