diff --git a/README.md b/README.md index 8b25856..ad015a4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # Sakura -_A backend that doesn't suck_ +![StyleCI](https://styleci.io/repos/45261697/shield) +![SensioLabsInsight](https://insight.sensiolabs.com/projects/6c9b3813-0f50-406c-ab26-665e11876bc9/mini.png) -I'll write a more descriptive readme once it's in a stable state. +## Requirements + +- PHP 5.5.0 or newer +- A database engine compatible with your PHP install and Laravel/Illuminate's database abstraction layer. + +_these will likely update in the future because i'm planning to go php 7 only_ + +## Contributing + +Right now I'm not accepting big PRs because of a set of big things not being fully implemented yet, bug fix PRs are more than welcome though! + +## License + +Sakura is licensed under the Apache License version 2. Check the [LICENSE file](https://github.com/flashwave/sakura/blob/master/LICENSE) for the full thing or if you just want a quick summary [click here](https://i.flash.moe/vlcsnap-2016-03-09-17h45m55s452.png).