Documentation

Author: steevanb

README.md

@@ -1 +1,44 @@
-[![status](https://img.shields.io/badge/status-dev-red.svg)](https://github.com/steevanb/symfony-container-introspection)
+[![version](https://img.shields.io/badge/version-1.0.0-green.svg)](https://github.com/steevanb/symfony-container-introspection/tree/1.0.0)
+[![php](https://img.shields.io/badge/php-^7.1-blue.svg)](https://php.net)
+[![symfony](https://img.shields.io/badge/symfony/dependency--injection-^3.4||^4.0-blue.svg)](https://symfony.com)
+![Lines](https://img.shields.io/badge/code%20lines-734-green.svg)
+![Total Downloads](https://poser.pugx.org/steevanb/symfony-container-introspection/downloads)
+[![Scrutinizer](https://scrutinizer-ci.com/g/steevanb/symfony-container-introspection/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/steevanb/symfony-container-introspection/)
+
+symfony-container-introspection
+===============================
+
+It helps you to know which services are registered, instanciated, public or private and list container parameters.
+
+You have access to Container cache statistics: files count, count code lines and cache size.
+
+With Symfony, a new profiler tab will appear:
+
+![Symfony profiler tab](symfony_profiler_tab.png)
+
+![Symfony profiler](symfony_profiler.png)
+
+[Changelog](changelog.md)
+
+Installation
+============
+
+```bash
+composer require steevanb/symfony-container-introspection ^1.0
+```
+
+If you use Symfony (and not just symfony/dependency-injection), you can add `ContainerIntrospectionBundle` to your Kernel:
+```php
+# app/AppKernel.php for Symfony 3.*
+# src/Kernel.php for Symfony 4.*
+
+class Kernel
+{
+    public function registerBundles()
+    {
+        if ($this->getEnvironment() === 'dev') {
+            $bundles[] = new \steevanb\ContainerIntrospection\Bridge\ContainerIntrospectionBundle\ContainerIntrospectionBundle();
+        }
+    }
+}
+```

changelog.md

@@ -0,0 +1,12 @@
+### 1.0.0 - 2018-06-06
+
+- Get registered services: `ContainerIntrospectionService::getRegisteredServices()`
+- Get instantiated services: `ContainerIntrospectionService::getInstantiatedServices()`
+- Get public services: `ContainerIntrospectionService::getPublicServices()`
+- Get private services: `ContainerIntrospectionService::getPrivateServices()`
+- Get container parameters: `ContainerIntrospectionService::getParameters()`
+- Get cache dir: `ContainerIntrospectionService::getContainerCacheDir()`
+- Count Container cache files: `ContainerIntrospectionService::countContainerCacheFiles()`
+- Count Container cache lines: `ContainerIntrospectionService::countContainerCacheLines()`
+- Count Container cache size: `ContainerIntrospectionService::getContainerCacheSize()`
+- Create bridge for Symfony: `ContainerIntrospectionBundle`

composer.json

@@ -8,7 +8,7 @@
     },
     "require": {
         "php": "^7.1",
-        "symfony/dependency-injection": "^3.3"
+        "symfony/dependency-injection": "^3.4||^4.0"
     },
     "repositories": [
         {