Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

updated readme

  • Loading branch information...
commit ab2464cedfa0ba64b04240a22060b4027a4f9e7a 1 parent 9ec280b
@geelen authored
Showing with 10 additions and 2 deletions.
  1. +10 −2 README.md
View
12 README.md
@@ -1,5 +1,13 @@
# Run a gist!
-This is running at http://GIST-ID-GOES-HERE.run-a-gist.herokuapp.com. It will look for a index.haml and an application.coffee, render and serve them.
+This is running at http://GIST-ID.run-a-gist.herokuapp.com. It will map requests to files within the corresponding GIST.
-For an example, see https://gist.github.com/e6b200de92bfbea61db0 and http://e6b200de92bfbea61db0.run-a-gist.herokuapp.com/
+The path / maps to index.html, everything else is dispatched as is.
+
+For a given url, if it is present directly within the gist, it will be served as-is. Otherwise, other formats are supported:
+
+* <name>.html will look for <name>.haml and compiled before serving.
+* <name>.css will look for <name>.scss or <name>.sass and compiled
+* <name>.js will look for <name>.coffee and compiled.
+
+For an example, go to http://2879097.run-a-gist.herokuapp.com/
Please sign in to comment.
Something went wrong with that request. Please try again.