Update documentation

susina · Sep 16, 2024 · ad5030d · ad5030d
1 parent f0639fc
commit ad5030d
Show file tree

Hide file tree

Showing 7 changed files with 5 additions and 64 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ or arrays. It's based on [Symfony Config](https://symfony.com/doc/current/compon
 [Propel configuration sub-system](https://github.com/propelorm/Propel2/tree/master/src/Propel/Common/Config).
 
 Supported configuration file formats are:
-- __.ini__
+
 - __.json__ via PHP json extension
 - __.neon__ via [Nette Neon](https://github.com/nette/neon) library
 - __.php__

diff --git a/docs/example.md b/docs/example.md
@@ -167,5 +167,5 @@ $connection = new Connection(
 );
 
 $template = new Template();
-$template->setDir($config->get('paths.template');
+$template->setDir($config->get('paths.template'));
 ```
diff --git a/docs/index.md b/docs/index.md
@@ -15,11 +15,10 @@ Building a configuration is a three-step process:
 
 We ship loaders for the following file formats:
 
--  __.ini__
 -  __.json__ via PHP json extension
 -  __.neon__ via [Nette Neon](https://github.com/nette/neon) library
 -  __.php__
--  __.xml__ via PHP SimpleXml, Xml and Dom extensions
+-  __.xml__ via [Susina xml to array](https://github.com/susina/xml-to-array) library
 -  __.yml__ via [Symfony Yaml](https://symfony.com/doc/current/components/yaml.html) component
 
 

diff --git a/docs/ini.md b/docs/ini.md
diff --git a/docs/installation.md b/docs/installation.md
@@ -22,9 +22,8 @@ Here are the list of supported file formats and the libraries to load:
 
 |Format|Supported file extension|Library to load|Installation|
 |------|------------------------|---------------|-------|
-|_ini_|.ini, .ini.dist|Bundled with PHP by default|enabled by default|
 |_json_|.json, .json.dist|Bundled with PHP by default|enabled by default|
 |_neon_|.neon, .neon.dist|[Nette Neon](https://ne-on.org/)|`composer require nette/neon`|
 |_php_|.php, .php.dist|PHP itself|none|
-|_xml_|.xml, .xml.dist|[simple-xml](https://www.php.net/manual/en/book.simplexml.php), [lib-xml](https://www.php.net/manual/en/book.libxml.php) and [dom](https://www.php.net/manual/en/dom.setup.php) PHP extensions|Usually enabled by default (please, check your PHP configuration)|
+|_xml_|.xml, .xml.dist|[Susina Xml To Array](https://github.com/susina/xml-to-array)|Automatically installed by composer|
 |_yaml_|.yaml, .yml, .yaml.dist, .yml.dist|[Symfony Yaml](https://symfony.com/doc/current/components/yaml.html)|`composer require symfony/yaml`|
diff --git a/docs/parameters.md b/docs/parameters.md
@@ -1,4 +1,4 @@
-The Configuration Builder supports the definition of some _parameters_ in your configuration file (any format). This functionality is inspired on [Symfony ParameterBag](https://github.com/symfony/symfony/blob/5.4/src/Symfony/Component/DependencyInjection/ParameterBag/ParameterBag.php).
+The Configuration Builder supports the definition of some _parameters_ in your configuration file (any format). This functionality is inspired on [Symfony ParameterBag](https://github.com/symfony/symfony/blob/5.4/src/Symfony/Component/DependencyInjection/ParameterBag/ParameterBag.php) and it's implemented by using [Susina ParamResolver](https://github.com/susina/param-resolver) library.
 
 A parameter is a previously defined property, put between `%` special character. When the builder found a parameter, it simply replaces its placeholder with the previously defined value. In example:
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -29,7 +29,6 @@ nav:
       - Usage: usage.md
       - Reference: 
         - Api: methods.md
-        - ini Format Reference: ini.md
         - Parameters reference: parameters.md
       - Complete Example: example.md
   - About: