agj avatar agj committed b530642

POD and readme

Comments (0)

Files changed (2)

README

-NAME
-    Avocado - A web anti-framework
-
-SYNOPSIS
-    Avocado is an anti-framework for web applications. It was written as an
-    exercise in organizing a framework from scratch.
-
-    I put avocado on my chili the night I started this. Yum.
-
-    Don't use this -- definitely not for anything important.
-
-    If you are masochistic, here you go. You were warned.
-
-      use Plack::Runner;
-      use Avocado;
-  
-      sub run {
-        guacamole(@_);
-
-        my $r = request();
-    
-        body(sprintf("The current page is: %s", $r->path_info));
-
-        return response();
-      }
-  
-      my $psgi = Plack::Runner->new;
-      $psgi->run(\&run);
-
-DESCRIPTION
-  EXPORT
-    None by default.
-
-SEE ALSO
-AUTHOR
-    Anthony Johnson, <anthony@ohess.org>
-
-COPYRIGHT AND LICENSE
-    Copyright (c) 2011 Anthony Johnson <anthony@ohess.org>
-
-    Permission is hereby granted, free of charge, to any person obtaining a
-    copy of this software and associated documentation files (the
-    "Software"), to deal in the Software without restriction, including
-    without limitation the rights to use, copy, modify, merge, publish,
-    distribute, sublicense, and/or sell copies of the Software, and to
-    permit persons to whom the Software is furnished to do so, subject to
-    the following conditions:
-
-    The above copyright notice and this permission notice shall be included
-    in all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
+h1. NAME
+
+Avocado
+
+h1. DESCRIPTION
+
+Avocado is syntactic sugar built on top of Plack that helps power the ohess.org website. Don't use this though, it was only a programming exercise. If you are masochistic, you can find the source code -- an example of Avocado usage -- on github.
+
+You were warned.
+
+h1. SEE ALSO
+
+http://github.com/agjohnson/ohess
+
+h1. AUTHOR
+
+Anthony Johnson, <aj@ohess.org>
+
+h1. COPYRIGHT AND LICENSE
+
+Copyright (c) 2011 Anthony Johnson <aj@ohess.org>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.