Readme and comments updates
This commit is contained in:
51
README.md
51
README.md
@ -7,10 +7,50 @@ This functionality applies to several commonly utilized page components such as
|
||||
|
||||
## Installation
|
||||
|
||||
You can install houdini using composer or include the autoload functionality inside the bin folder.
|
||||
To install simply use the composer command:
|
||||
|
||||
`php composer.phar require thetempusproject/houdini`
|
||||
|
||||
## Usage
|
||||
|
||||
Typical usage would be through including the package via composer.
|
||||
|
||||
```php
|
||||
|
||||
require_once VENDOR_DIRECTORY . 'autoload.php';
|
||||
|
||||
use TheTempusProject\Houdini\Classes\Template;
|
||||
|
||||
new Template;
|
||||
Template::setTemplate( 'default' );
|
||||
|
||||
```
|
||||
|
||||
If you would like to use hermes autoloading, simply inclode the constants file and the autoload file inside `/bin/`.
|
||||
|
||||
```php
|
||||
|
||||
use TheTempusProject\Houdini\Classes\Template;
|
||||
|
||||
// Houdini Constants
|
||||
if ( ! defined( 'HOUDINI_CONSTANTS_LOADED' ) ) {
|
||||
if ( defined( 'HOUDINI_CONFIG_DIRECTORY' ) ) {
|
||||
require_once HOUDINI_CONFIG_DIRECTORY . 'constants.php';
|
||||
}
|
||||
}
|
||||
|
||||
// Houdini Autoloader (Autoloader)
|
||||
if ( ! defined( 'HOUDINI_AUTOLOADED' ) ) {
|
||||
if ( defined( 'HOUDINI_ROOT_DIRECTORY' ) ) {
|
||||
require_once HOUDINI_ROOT_DIRECTORY . 'bin' . DIRECTORY_SEPARATOR . 'autoload.php';
|
||||
}
|
||||
}
|
||||
|
||||
new Template;
|
||||
Template::setTemplate( 'default' );
|
||||
|
||||
```
|
||||
|
||||
### Components
|
||||
### Email
|
||||
### Filters
|
||||
@ -22,3 +62,12 @@ You can install houdini using composer or include the autoload functionality ins
|
||||
|
||||
## Constants / Settings
|
||||
|
||||
|
||||
|
||||
## Issues / Bugs / Contact
|
||||
|
||||
If anyone actually uses this library and runs into any issues, feel free to contact me and I'll look into it.
|
||||
|
||||
[Joey Kimsey](mailto:Joey@thetempusproject.com) - _Lead Developer_
|
||||
|
||||
[JoeyKimsey.com](https://JoeyKimsey.com)
|
||||
|
Reference in New Issue
Block a user