From 40e929e7a60c55917dd9701c00724a752d50f595 Mon Sep 17 00:00:00 2001 From: Kyle Johnson Date: Tue, 29 Apr 2014 20:49:54 +0000 Subject: [PATCH] Changed the API readme to be ZoneMinder-relevant --- web/api/README.md | 49 ++++++++++------------------------------------- 1 file changed, 10 insertions(+), 39 deletions(-) diff --git a/web/api/README.md b/web/api/README.md index 343abce10..6a1d6a325 100644 --- a/web/api/README.md +++ b/web/api/README.md @@ -1,43 +1,14 @@ -CakePHP -======= +ZoneMinder API +============== -[![CakePHP](http://cakephp.org/img/cake-logo.png)](http://www.cakephp.org) +This is the ZoneMinder API. It should be, for now, installed under the webroot +e.g. /api. -CakePHP is a rapid development framework for PHP which uses commonly known design patterns like Active Record, Association Data Mapping, Front Controller and MVC. -Our primary goal is to provide a structured framework that enables PHP users at all levels to rapidly develop robust web applications, without any loss to flexibility. +app/Config/database.php.default must be configured and copied to +app/Config/database.php -Some Handy Links ----------------- +In adition, Security.salt and Security.cipherSeed in app/Config/core.php should +be changed. -[CakePHP](http://www.cakephp.org) - The rapid development PHP framework - -[CookBook](http://book.cakephp.org) - THE CakePHP user documentation; start learning here! - -[API](http://api.cakephp.org) - A reference to CakePHP's classes - -[Plugins](http://plugins.cakephp.org/) - A repository of extensions to the framework - -[The Bakery](http://bakery.cakephp.org) - Tips, tutorials and articles - -[Community Center](http://community.cakephp.org) - A source for everything community related - -[Training](http://training.cakephp.org) - Join a live session and get skilled with the framework - -[CakeFest](http://cakefest.org) - Don't miss our annual CakePHP conference - -[Cake Software Foundation](http://cakefoundation.org) - Promoting development related to CakePHP - -Get Support! ------------- - -[#cakephp](http://webchat.freenode.net/?channels=#cakephp) on irc.freenode.net - Come chat with us, we have cake - -[Google Group](https://groups.google.com/group/cake-php) - Community mailing list and forum - -[GitHub Issues](https://github.com/cakephp/cakephp/issues) - Got issues? Please tell us! - -[Roadmaps](https://github.com/cakephp/cakephp/wiki#roadmaps) - Want to contribute? Get involved! - -[![Bake Status](https://secure.travis-ci.org/cakephp/cakephp.png?branch=master)](http://travis-ci.org/cakephp/cakephp) - -![Cake Power](https://raw.github.com/cakephp/cakephp/master/lib/Cake/Console/Templates/skel/webroot/img/cake.power.gif) +The API can run on a dedicated / separate instance, so long as it can access +the database as ocnfigured in app/Config/database.php