Fix docs

yiisoft · May 8, 2024 · 4fd3c2f · 4fd3c2f
1 parent 74515ab
commit 4fd3c2f
Show file tree

Hide file tree

Showing 23 changed files with 43 additions and 48 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -5,13 +5,13 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 
-* Redistributions of source code must retain the above copyright
+ * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
-* Redistributions in binary form must reproduce the above copyright
+ * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
-* Neither the name of Yii Software nor the names of its
+ * Neither the name of Yii Software nor the names of its
    contributors may be used to endorse or promote products derived
    from this software without specific prior written permission.
 

diff --git a/README.md b/README.md
@@ -27,8 +27,10 @@ and plugins in terms of Yii widgets, and thus makes using Bulma components/plugi
 
 ## Installation
 
+The package could be installed with [Composer](https://getcomposer.org):
+
 ```shell
-composer require yiisoft/yii-bulma --prefer-dist
+composer require yiisoft/yii-bulma
 ```
 
 ## Install assets
@@ -68,8 +70,8 @@ Add to composer.json file the following:
 
 Once the changes are made, you can install the assets using the following command:
 
-```php
-composer update --prefer-dist
+```shell
+composer update
 ```
 
 2. Using the [npm-asset](https://www.npmjs.com/) package manager.
@@ -146,14 +148,19 @@ $this->setJsFiles($assetManager->getJsFiles());
 
 ## Documentation
 
-- [Guides](docs/guide/README.md)
+- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md)
 - [Internals](docs/internals.md)
 
-## Support
-
 If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
 You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
 
+## License
+
+The Yii Framework Bulma Integration is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
+
+Maintained by [Yii Software](https://www.yiiframework.com/).
+
 ## Support the project
 
 [![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)
@@ -165,10 +172,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework.
 [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
 [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
 [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
-
-## License
-
-The Yii Framework Bulma Integration is free software. It is released under the terms of the BSD License.
-Please see [`LICENSE`](./LICENSE.md) for more information.
-
-Maintained by [Yii Software](https://www.yiiframework.com/).
diff --git a/docs/guide/README.md b/docs/guide/README.md
diff --git a/docs/guide/en/dropdown.md b/docs/guide/en/dropdown.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/dropdown.png">
+    <img src="../../images/dropdown.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/en/menu.md b/docs/guide/en/menu.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/menu.png">
+    <img src="../../images/menu.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/en/message.md b/docs/guide/en/message.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/message.png">
+    <img src="../../images/message.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/en/modal.md b/docs/guide/en/modal.md
@@ -11,7 +11,7 @@ The modal structure:
 
 <p align="center">
     </br>
-    <img src="images/modal.png">
+    <img src="../../images/modal.png">
 </p>
 
 ## Usage

diff --git a/docs/guide/en/modalcard.md b/docs/guide/en/modalcard.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/modal_card.png">
+    <img src="../../images/modal_card.png">
 </p>
 
 The modal structure:

diff --git a/docs/guide/en/navbar.md b/docs/guide/en/navbar.md
@@ -4,17 +4,17 @@
 
 <p align="center">
     </br>
-    <img src="images/navbar.png">
+    <img src="../../images/navbar.png">
 </p>
 
 <p align="center">
     </br>
-    <img src="images/navbar-responsive-1.png">
+    <img src="../../images/navbar-responsive-1.png">
 </p>
 
 <p align="center">
     </br>
-    <img src="images/navbar-responsive-2.png">
+    <img src="../../images/navbar-responsive-2.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/en/panel.md b/docs/guide/en/panel.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/panel.png">
+    <img src="../../images/panel.png">
 </p>
 
 ## Usage

diff --git a/docs/guide/en/progressbar.md b/docs/guide/en/progressbar.md
@@ -6,13 +6,13 @@
 Loading widget looks like the following:
 
 <p align="center">
-    <img src="images/progressbar.png">
+    <img src="../../images/progressbar.png">
 </p>
 
 In progress widget looks like this:
 
 <p align="center">
-    <img src="images/progressbar-indeterminate.gif">
+    <img src="../../images/progressbar-indeterminate.gif">
 </p>
 
 ## Usage

diff --git a/docs/guide/en/tabs.md b/docs/guide/en/tabs.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/tabs.png">
+    <img src="../../images/tabs.png">
 </p>
 
 ## Usage

diff --git a/docs/guide/pt-BR/breadcrumbs.md b/docs/guide/pt-BR/breadcrumbs.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/breadcrumbs.png">
+    <img src="../../images/breadcrumbs.png">
 </p>
 
 ## Usage

diff --git a/docs/guide/pt-BR/dropdown.md b/docs/guide/pt-BR/dropdown.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/dropdown.png">
+    <img src="../../images/dropdown.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/pt-BR/menu.md b/docs/guide/pt-BR/menu.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/menu.png">
+    <img src="../../images/menu.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/pt-BR/message.md b/docs/guide/pt-BR/message.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/message.png">
+    <img src="../../images/message.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/pt-BR/modal.md b/docs/guide/pt-BR/modal.md
@@ -11,7 +11,7 @@ The modal structure:
 
 <p align="center">
     </br>
-    <img src="images/modal.png">
+    <img src="../../images/modal.png">
 </p>
 
 ## Usage

diff --git a/docs/guide/pt-BR/modalcard.md b/docs/guide/pt-BR/modalcard.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/modal_card.png">
+    <img src="../../images/modal_card.png">
 </p>
 
 The modal structure:

diff --git a/docs/guide/pt-BR/navbar.md b/docs/guide/pt-BR/navbar.md
@@ -4,17 +4,17 @@
 
 <p align="center">
     </br>
-    <img src="images/navbar.png">
+    <img src="../../images/navbar.png">
 </p>
 
 <p align="center">
     </br>
-    <img src="images/navbar-responsive-1.png">
+    <img src="../../images/navbar-responsive-1.png">
 </p>
 
 <p align="center">
     </br>
-    <img src="images/navbar-responsive-2.png">
+    <img src="../../images/navbar-responsive-2.png">
 </p>
 
 HTML generated consists of:

diff --git a/docs/guide/pt-BR/panel.md b/docs/guide/pt-BR/panel.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/panel.png">
+    <img src="../../images/panel.png">
 </p>
 
 ## Usage

diff --git a/docs/guide/pt-BR/progressbar.md b/docs/guide/pt-BR/progressbar.md
@@ -6,13 +6,13 @@
 Loading widget looks like the following:
 
 <p align="center">
-    <img src="images/progressbar.png">
+    <img src="../../images/progressbar.png">
 </p>
 
 In progress widget looks like this:
 
 <p align="center">
-    <img src="images/progressbar-indeterminate.gif">
+    <img src="../../images/progressbar-indeterminate.gif">
 </p>
 
 ## Usage

diff --git a/docs/guide/pt-BR/tabs.md b/docs/guide/pt-BR/tabs.md
@@ -4,7 +4,7 @@
 
 <p align="center">
     </br>
-    <img src="images/tabs.png">
+    <img src="../../images/tabs.png">
 </p>
 
 ## Usage

diff --git a/docs/internals.md b/docs/internals.md
@@ -25,7 +25,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
 ./vendor/bin/psalm
 ```
 
-## Rector
+## Code style
 
 Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
 use either newest or any specific version of PHP:
@@ -34,7 +34,7 @@ use either newest or any specific version of PHP:
 ./vendor/bin/rector
 ```
 
-## Composer require checker
+## Dependencies
 
 This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.