From 3d21920ba975d58d8f6a6cd20fa9601069740b53 Mon Sep 17 00:00:00 2001
From: John Ryan <ryjohn@google.com>
Date: Wed, 20 Nov 2019 09:51:03 -0800
Subject: [PATCH] add deployment documentation to web/ directory (#164)

* add deployment documentation to web/ directory

* add clarification

* formatting
---
 web/readme.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/web/readme.md b/web/readme.md
index a497d9623..163df7198 100644
--- a/web/readme.md
+++ b/web/readme.md
@@ -23,6 +23,20 @@ Web support is available as a technical preview and is only available in the
 
 You should see a message printing the URL to access: `http://localhost:8080`
 
+## Deploying to GitHub Pages
+
+This project uses [peanut][peanut] to build the samples and commit the output
+to the gh-pages branch. To deploy, run these commands in the `web/` directory:
+
+```console
+$ flutter pub global activate peanut
+$ flutter pub global run peanut
+$ git push origin gh-pages:gh-pages
+```
+
+Note: `flutter packages get` must be run in each sample before running `peanut`.
+
 [web]: https://flutter.dev/web
 [samples]: https://flutter.github.io/samples/
+[peanut]: https://github.com/kevmoo/peanut.dart