diff --git a/README.md b/README.md index 21caf0d..65a6c43 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ -SOMA Framework -============== +# SOMA Framework -Soma is a lightweight PHP micro-framework, designed to provide the bare essentials and lay a foundation for a developer to modularly put together their application without the framework getting in the way. `soma/framework` is the core that provides config loading, DI container, environment loading, service providers, facades, class aliases and a command line interface. +SOMA, *Slim Open Modular Framework*, is a lightweight PHP micro-framework, designed to provide the bare essentials and lay a foundation for a developer to modularly put together their application without the framework getting in the way. `soma/soma` is the core that provides config loading, DI container, environment loading, service providers, facades, class aliases and a command line interface. ## Installation *Soma requires composer for dependency management* ```sh -composer require soma/framework +composer require soma/soma ``` If you want to start an entirely new project rather than integrating it into your current solution you can use [soma/project](https://github.com/soma-php/project) as scaffolding: @@ -130,7 +129,7 @@ $appName = config('app.name'); ### Services -The service providers are how you can modularly add in functionality to your application. The `ServiceProvider` class has been designed to be compatible with `Illuminate\Support\ServiceProvider` and should be able to register them as well as long as they don't call any Laravel specific code. It's also been designed according to the now deprecated [ContainerInterop](https://github.com/container-interop/service-provider) standard. Unfortunately the extension definitions have the arguments reversed in Soma for compatibility with PHP-DI, the container library. A typical `ServiceProvider` may look like the following: +The service providers are how you can modularly add in functionality to your application. The `ServiceProvider` class has been designed to be compatible with `Illuminate\Support\ServiceProvider` and should be able to register them as well as long as they don't call any Laravel specific code. It's also been designed according to the now deprecated [ContainerInterop](https://github.com/container-interop/service-provider) standard. Unfortunately the extension definitions have the arguments reversed in SOMA for compatibility with PHP-DI, the container library. A typical `ServiceProvider` may look like the following: ```php