|
|
@@ -10,41 +10,48 @@ Koseven is an elegant, open source, and object oriented HMVC framework built usi
|
|
|
|
|
|
Released under a [BSD license](LICENSE.md), Koseven can be used legally for any open source, commercial, or personal project.
|
|
|
|
|
|
-## Why a Kohana alternative?
|
|
|
+## History/Why a Kohana alternative?
|
|
|
|
|
|
-I use Kohana 3.3.x in many live projects and migration will be really complex into any new PHP framework. Keeping the project alive and updated is a priority. Kohana team (which I belong too) will not release any new version. [Kohana is DEAD](http://discourse.kohanaframework.org/t/kohana-retirement-2017-07-01/1277)
|
|
|
+Kohana 3.3.x is used by us in many live projects, and the original team (where @neo22s belonged too) stopped the development a while ago and on Feb 4, 2017 Shadowhand announced the final retirement [Kohana is DEAD](http://discourse.kohanaframework.org/t/kohana-retirement-2017-07-01/1277).
|
|
|
|
|
|
-I will keep updated tihs repo with any other new issues or features released at Kohana.
|
|
|
+Before the final announcement everyone started to check if it was possible to migrate existing projects to other alternative PHP frameworks. As it turned out switching would be a complex and lengthy job.
|
|
|
+So it became clear that keeping the project alive and updated is a priority.
|
|
|
+
|
|
|
+And so the Koseven repository was born and will keep this repository updated for future releases of PHP, giving the framework a clear perspective for the future.
|
|
|
|
|
|
## Will work as dropin of Kohana?
|
|
|
|
|
|
-If you were using 3.3.x version normally yes. Normally? theres 2 breaking changes that may affect you, be aware. We have removed MySQL (you need to use MySQLi) and exception.php is now compatible with PHP7.
|
|
|
+If you were using 3.3.x version normally yes. Normally? There are 2 breaking changes that may affect you, be aware. We have removed MySQL support (in favor for MySQLi) and exception.php is now compatible with PHP7.
|
|
|
|
|
|
We have also added the pagination module.
|
|
|
|
|
|
## What changes have you made?
|
|
|
|
|
|
-So far is exactly as last stable version of KO 3.3.6 released on Jul 25, 2016. But compatible with PHP 7 / PHP 7.1. We only add fixes, bug fixes, speed improvements and the rest leave it for the modules.
|
|
|
+So far is exactly as last stable version of KO 3.3.6 released on Jul 25, 2016. But compatible with PHP 7 / PHP 7.1.
|
|
|
+Our focus is to keep the framework compatible with new releases of PHP, fix bugs and try to improve the speed.
|
|
|
+New features can be added using modules.
|
|
|
|
|
|
-## Are modules of Kohana compatible?
|
|
|
+## Are modules of the original Kohana compatible?
|
|
|
|
|
|
-Yes they are, just be sure are compatible with KO 3.3.X.
|
|
|
+Yes they are, just be sure that they are compatible with KO 3.3.X.
|
|
|
+An overview of Koseven’s team own modules can be found on [this](https://koseven.ga/modules.html) page.
|
|
|
+There’s also a list online with a nice overview of existing modules maintained (or abandoned) by others. You can consult this list at [kohana-modules.com](https://koseven.ga/modules.html)
|
|
|
|
|
|
## Why all modules in 1 repo?
|
|
|
|
|
|
-This is a personal choice for me to keep the project as simple and easier to manage, modules are not enabled by default, just do not enable those you will not use.
|
|
|
+This was personal choice of @neo22s to keep the project as simple and easier to manage. The modules are commonly used and are not enabled by default. If not used they can be removed from the codebase.
|
|
|
|
|
|
## I Need help!
|
|
|
|
|
|
-Feel free to [open an issue on github](https://github.com/koseven/koseven/issues/new). Please be as specific as possible if you want to get help. You can also [Join the Telegram group] (https://telegram.me/koseven)
|
|
|
+Feel free to [open an issue on github](https://github.com/koseven/koseven/issues/new). Please be as specific as possible if you want to get help. You can also [Join the Telegram group](https://telegram.me/koseven)
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
-We are working to improve currents Kohana's documentation but in the meantime fill free to use the one provided by KO.
|
|
|
+We are working to improve the original Kohana documentation but in the meantime fill free to use the one provided by KO.
|
|
|
|
|
|
-Koseven documentation can be found at <https://docs.koseven.ga/> which also contains an API browser.
|
|
|
+Koseven documentation can be found at [docs.koseven.ga](https://docs.koseven.ga) which also contains an API browser.
|
|
|
|
|
|
-The `userguide` module included in all Kohana releases also allows you to view the documentation locally. Once the `userguide` module is enabled in the bootstrap, it is accessible from your site via `/index.php/guide` (or just `/guide` if you are rewriting your URLs).
|
|
|
+The `userguide` module included in all Kohana/Koseven releases allows you to view the documentation locally. To use it you need to enable the`userguide` module in the bootstrap.php file (found in the `application` directory). Next you should be able to read the documentation from your own site via `/index.php/guide` (or just `/guide` if you are rewriting your URLs).
|
|
|
|
|
|
## Reporting bugs
|
|
|
If you've stumbled across a bug, please help us out by [reporting the bug](https://github.com/koseven/koseven/issues/new) you have found. Simply log in or register and submit a new issue, leaving as much information about the bug as possible, e.g.
|
|
|
@@ -57,4 +64,4 @@ This will help us to fix the bug as quickly as possible, and if you'd like to fi
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
-Any help is more than welcome! please see [Contributing](CONTRIBUTING.md)
|
|
|
+Any help is more than welcome! Please see [Contributing](CONTRIBUTING.md)
|
Sven Rymenants - Byteworks