Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

add documentation

  • Loading branch information...
commit c2ef1c4eae707966a548d17b5433389ab51ac512 1 parent eb1cbec
@adamlogic authored
Showing with 20 additions and 13 deletions.
  1. +0 −13 README
  2. +20 −0 README.rdoc
View
13 README
@@ -1,13 +0,0 @@
-Mockups
-=======
-
-Introduction goes here.
-
-
-Example
-=======
-
-Example goes here.
-
-
-Copyright (c) 2009 [name of plugin creator], released under the MIT license
View
20 README.rdoc
@@ -0,0 +1,20 @@
+= Showoff
+
+The showoff plugin gives you a simple way to throw arbitrary HTML mockups into your appliction.
+You can use static HTML, ERB, or any other template language (such as HAML) that your
+application supports.
+
+== How do I install it?
+
+ script/plugin install git://github.com/adamlogic/showoff.git
+ script/generate showoff
+
+== How do I use it?
+
+Just throw your mockups into app/views/mockups, then navigate to /mockups in your app.
+
+== Can I see an example?
+
+Once you've run the generator, navigate to /mockups in your app to see some examples.
+
+Copyright (c) 2009 [Adam McCrea], released under the MIT license
Please sign in to comment.
Something went wrong with that request. Please try again.