Merge pull request #2 from rcthomas/add-images

Add images
rcthomas · Sep 29, 2019 · f17dbd7 · f17dbd7
2 parents 1e973f6 + 943b5a8
commit f17dbd7
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 10 deletions.
diff --git a/.gitignore b/.gitignore
@@ -108,3 +108,5 @@ dmypy.json
 .pyre/
 
 # End of https://www.gitignore.io/api/python
+
+.DS_Store
diff --git a/README.md b/README.md
@@ -55,27 +55,32 @@ If you're running this locally on port 8000 (or in a Docker container with that
 
 If all goes well you'll see a mostly blank JupyterHub-style page with "None" for the "Latest Announcement."
 
-    PLACE FIGURE HERE
+![Unauthenticated view](docs/resources/01-unauthenticated-view.png "Unauthenticated view")
 
 Now go ahead and click the convenient login button.
 Log in as an admin user, then go back to the above URL.
 
-    PLACE FIGURE HERE
+![Admin view uninitialized](docs/resources/02-admin-view-uninitialized.png "Admin view uninitialized")
 
 You'll now see the same page as before but with a text box.
-Enter a message like 
+Enter a message.
 
-    Apologies. JupyterHub will be down for interociter maintenance at 3:30 PM 
-    Earth time and it will take 20 of your Earth "minutes."
+![Admin view filling out](docs/resources/03-admin-view-filling-out.png "Admin view filling out")
 
 That becomes the Latest Announcement.
+
+![Admin view filled out](docs/resources/04-admin-view-filled-out.png "Admin view filled out")
+
 If you enter an empty message, it clears that message and demotes it to a Previous Announcement.
-Go on.  Add a few more.  Then log out.
 
-    PLACE FIGURE HERE
+![Admin view cleared](docs/resources/05-admin-view-cleared.png "Admin view cleared")
 
-Now log in using a test user who is not an admin (you have one right?).
+Go on.  Add a few more.  Then log out.
+Now log in using a test user who is not an admin.
 Point back at the announcement page and there you see all these wonderful communications your friendly admin sent to you.
+
+![User view](docs/resources/06-user-view.png "User view")
+
 Log out again and have a look.
 You can see them even if you're logged out.
 
@@ -105,5 +110,3 @@ The persistence file is just JSON.
 ## Things That Could Use Work
 
 We should put a cap on the size of the announcement queue, or expire them after some time period.
-
-The README could have more pictures.
diff --git a/docs/resources/01-unauthenticated-view.png b/docs/resources/01-unauthenticated-view.png
diff --git a/docs/resources/02-admin-view-uninitialized.png b/docs/resources/02-admin-view-uninitialized.png
diff --git a/docs/resources/03-admin-view-filling-out.png b/docs/resources/03-admin-view-filling-out.png
diff --git a/docs/resources/04-admin-view-filled-out.png b/docs/resources/04-admin-view-filled-out.png
diff --git a/docs/resources/05-admin-view-cleared.png b/docs/resources/05-admin-view-cleared.png
diff --git a/docs/resources/06-user-view.png b/docs/resources/06-user-view.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -108,3 +108,5 @@ dmypy.json
		.pyre/

		# End of https://www.gitignore.io/api/python

		.DS_Store