= MARGOT
by: The Polymorphers
* cdcarter
* willcodeforfoo
* defunkt
== DESCRIPTION:
Margot is the missing link between Mongrel (http://mongrel.rubyforge.org) and Markaby (http://code.whytheluckystiff.net/markaby). It is a full webserver that parses and serves Markaby files, giving access to the request information and the parameters
== FEATURES/PROBLEMS:
* The query string, and POST/PUT parameters are available through the +params+ hash
* Other request data can be attained through the +request+ method
* The Markaby instance is called +mab+ (But you do not need to call it directly. The +html+ method is an alias to +mab.html+)
* Margot keeps an in memory cache of pages and their parameters!
* To clear the cache and garbage collect, just send a USR1 signal to the process
* The mongrel status information is mounted by default at /status
* A directory handler is loaded at /assets to the directory +./assets+
* There is daemonization support but it is borked at the moment
* Template and layout handling
== REQUIREMENTS:
Margot requires the following gems
* Markaby
* Mongrel
== INSTALL:
sudo gem install margot
== Usage
To use Margot you just create a directory structure, with each subdirectory, and the root containing an +index.mab+ and a +layout.mab+, and start Margot on that directory
$ margot 0.0.0.0 3000 ./sites
== LICENSE:
(The MIT License)
Copyright (c) 2006 FIX
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.
by: The Polymorphers
* cdcarter
* willcodeforfoo
* defunkt
== DESCRIPTION:
Margot is the missing link between Mongrel (http://mongrel.rubyforge.org) and Markaby (http://code.whytheluckystiff.net/markaby). It is a full webserver that parses and serves Markaby files, giving access to the request information and the parameters
== FEATURES/PROBLEMS:
* The query string, and POST/PUT parameters are available through the +params+ hash
* Other request data can be attained through the +request+ method
* The Markaby instance is called +mab+ (But you do not need to call it directly. The +html+ method is an alias to +mab.html+)
* Margot keeps an in memory cache of pages and their parameters!
* To clear the cache and garbage collect, just send a USR1 signal to the process
* The mongrel status information is mounted by default at /status
* A directory handler is loaded at /assets to the directory +./assets+
* There is daemonization support but it is borked at the moment
* Template and layout handling
== REQUIREMENTS:
Margot requires the following gems
* Markaby
* Mongrel
== INSTALL:
sudo gem install margot
== Usage
To use Margot you just create a directory structure, with each subdirectory, and the root containing an +index.mab+ and a +layout.mab+, and start Margot on that directory
$ margot 0.0.0.0 3000 ./sites
== LICENSE:
(The MIT License)
Copyright (c) 2006 FIX
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.