diff --git a/README.md b/README.md index 8d1c8b6..836177a 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ - +# Zappy PHP MicroFramework + +This is the main repository for the Zappy MicroFramework. It contains the base +framework files needed to make it all work. Additional components are +available in separate repositories. + +--- + +## How to use + +The framework can be added to your project using composer. Currently this +project is not yet distributed on Packagist, so you will have to manually +add this repository to your composer.json file: + +```json +"repositories": [ + { + "type": "vcs", + "url": "https://forge.subcon.town/crocwork/zappy-base" + } +] +``` + +You can then install the framework with composer: +`composer require crocwork\zappy-base:dev-development` + +**Keep in mind** that this software is still in very early stages of development: +it's not production ready and should not be used for production environments. + +## License + +This software is licensed under the MIT License. Please view the included LICENSE +file for details. + +## Collaboration + +If you want to collaborate or need information, feel free to contact me on the +[fediverse](https://akkos.fritu.re/fristi). Pull requests are also welcome. \ No newline at end of file