diff --git a/README.md b/README.md index ce23a87..0f2917b 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,52 @@ -# Tempus Project Core -###### Developer(s): Joey Kimsey -Bedrock is the core functionality used by [The Tempus Project](https://github.com/TheTempusProject/TheTempusProject) a rapid prototyping framework. This Library can be utilized outside of the TempusProject, but the functionality has not been tested well as a stand alone library. +# Bedrock + +## Developer(s): Joey Kimsey This library utilizes the MVC architecture in addition to a custom templating engine designed to make building web applications fast and simple. +Bedrock is the core functionality used by [The Tempus Project](https://github.com/TheTempusProject/TheTempusProject) a rapid prototyping framework. It provides database support, configuration, base models, and base controller functionality a in addition to a host of other integrated functions. + +This Library can be utilized outside of TheTempusProject, but the functionality has not been tested well as a stand-alone library. + **Notice: This Library is provided as is, please use at your own risk.** ## Installation and Use -The easiest way to use Bedrock in your application is to install and initialize it via composer. -``` +The easiest way to use Bedrock in your application is to install it via composer and extend the main app inside of the bin folder. + +`Composer.json` + +```json "require": { "TheTempusProject/Bedrock": "*", }, "autoload": { "psr-4": { - "Bedrock\": "vendor/TheTempusProject/Bedrock" + "TheTempusProject\\Bedrock\\": "vendor/thetempusproject/bedrock", } } ``` -If you prefer to handle auto-loading via other means, you can simply clone this repository wherever you need it. Please note, you will need to install and load the [TempusDebugger](https://github.com/thetempusproject/TempusDebugger) library in order to utilize the debug to console options. +`app.php` + +```php + +``` + +If you prefer to handle auto-loading via other means, you can simply clone this repository wherever you need it. + +### To-Do -### WIP: - [ ] Expansion of PDO to allow different database types -- [ ] template stuff should really only be called from template/controllers -- [ ] Update installer to account for updates. -- [ ] Implement uniformity in terms of error reporting, exceptions, logging. +- [ ] Updates for configs and models to re-build based on a delta model, to make version changes simpler. (Migration system) +- [ ] Implement better uniformity in terms of error reporting, exceptions, logging.