Skip to content

Commit 5a4ebac

Browse files
josantoniusjosantonius
committed
docs: improve documentation
Closes #2
1 parent 1ccb91b commit 5a4ebac

File tree

2 files changed

+85
-92
lines changed

2 files changed

+85
-92
lines changed

‎.github/lang/es-ES/README.md‎

Lines changed: 44 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ Para instalar **PHP Asset library**, simplemente escribe:
4343
composer require josantonius/asset
4444
```
4545

46-
El comando anterior sólo instalará los archivos necesarios, si prefieres **descargar todo el código fuente** puedes utilizar:
46+
El comando anterior sólo instalará los archivos necesarios,
47+
si prefieres **descargar todo el código fuente** puedes utilizar:
4748

4849
```console
4950
composer require josantonius/asset --prefer-source
@@ -63,84 +64,78 @@ Métodos disponibles en esta biblioteca:
6364

6465
```php
6566
new BodyScript(
66-
null|bool $async = null,
67-
null|string $crossorigin = null,
68-
null|bool $defer = null,
69-
null|string $fetchpriority = null,
70-
null|string $integrity = null,
71-
null|bool $nomodule = null,
72-
null|string $nonce = null,
67+
null|bool $async = null,
68+
null|string $crossorigin = null,
69+
null|bool $defer = null,
70+
null|string $fetchpriority = null,
71+
null|string $integrity = null,
72+
null|bool $nomodule = null,
73+
null|string $nonce = null,
7374
null|string $referrerpolicy = null,
74-
null|string $src = null,
75-
null|string $type = null
75+
null|string $src = null,
76+
null|string $type = null
7677
);
7778
```
7879

7980
### Agregar _script_ en el _head_
8081

8182
```php
8283
new HeadScript(
83-
null|bool $async = null,
84-
null|string $crossorigin = null,
85-
null|bool $defer = null,
86-
null|string $fetchpriority = null,
87-
null|string $integrity = null,
88-
null|bool $nomodule = null,
89-
null|string $nonce = null,
84+
null|bool $async = null,
85+
null|string $crossorigin = null,
86+
null|bool $defer = null,
87+
null|string $fetchpriority = null,
88+
null|string $integrity = null,
89+
null|bool $nomodule = null,
90+
null|string $nonce = null,
9091
null|string $referrerpolicy = null,
91-
null|string $src = null,
92-
null|string $type = null
92+
null|string $src = null,
93+
null|string $type = null
9394
);
9495
```
9596

9697
### Agregar _link_
9798

9899
```php
99100
new Link(
100-
null|string $as = null,
101-
null|string $crossorigin = null,
102-
null|bool $disabled = null,
103-
null|string $fetchpriority = null,
104-
null|string $href = null,
105-
null|string $hreflang = null,
106-
null|string $imagesizes = null,
107-
null|string $imagesrcset = null,
108-
null|string $integrity = null,
109-
null|string $media = null,
110-
null|string $prefetch = null,
101+
null|string $as = null,
102+
null|string $crossorigin = null,
103+
null|bool $disabled = null,
104+
null|string $fetchpriority = null,
105+
null|string $href = null,
106+
null|string $hreflang = null,
107+
null|string $imagesizes = null,
108+
null|string $imagesrcset = null,
109+
null|string $integrity = null,
110+
null|string $media = null,
111+
null|string $prefetch = null,
111112
null|string $referrerpolicy = null,
112-
null|string $rel = null,
113-
null|string $sizes = null,
114-
null|string $target = null,
115-
null|string $title = null,
116-
null|string $type = null,
113+
null|string $rel = null,
114+
null|string $sizes = null,
115+
null|string $target = null,
116+
null|string $title = null,
117+
null|string $type = null,
117118
);
118119
```
119120

120121
### Imprime los _scripts_ añadidos para el _body_
121122

122123
```php
123-
$asset->outputBodyScripts();
124+
$asset->outputBodyScripts(): string
124125
```
125126

126-
**@Return** `string` _Scripts_ añadidos
127-
128127
### Imprime los _scripts_ añadidos para el _head_
129128

130129
```php
131-
$asset->outputHeadScripts();
130+
$asset->outputHeadScripts(): string
132131
```
133132

134-
**@Return** `string` _Scripts_ añadidos
135-
136133
### Imprime los _links_ añadidos
137134

138135
```php
139-
$asset->outputLinks();
136+
$asset->outputLinks(): string
140137
```
141138

142-
**@Return** `string` _Links_ añadidos
143-
144139
## Cómo empezar
145140

146141
### Utilizando objetos
@@ -361,7 +356,8 @@ use Josantonius\Asset\Facades\Asset;
361356

362357
## Tests
363358

364-
Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/) y seguir los siguientes pasos:
359+
Para ejecutar las [pruebas](tests) necesitarás [Composer](http://getcomposer.org/download/)
360+
y seguir los siguientes pasos:
365361

366362
```console
367363
git clone https://github.com/josantonius/php-asset.git
@@ -387,7 +383,8 @@ Ejecutar pruebas de estándares de código con [PHPCS](https://github.com/squizl
387383
composer phpcs
388384
```
389385

390-
Ejecutar pruebas con [PHP Mess Detector](https://phpmd.org/) para detectar inconsistencias en el estilo de codificación:
386+
Ejecutar pruebas con [PHP Mess Detector](https://phpmd.org/)
387+
para detectar inconsistencias en el estilo de codificación:
391388

392389
```console
393390
composer phpmd
@@ -420,7 +417,7 @@ Los cambios detallados de cada versión se documentan en las
420417
Por favor, asegúrate de leer la [Guía de contribución](CONTRIBUTING.md) antes de hacer un
421418
_pull request_, comenzar una discusión o reportar un _issue_.
422419

423-
¡Gracias por [colaborar](https://github.com/josantonius/php-json/graphs/contributors)! :heart:
420+
¡Gracias por [colaborar](https://github.com/josantonius/php-asset/graphs/contributors)! :heart:
424421

425422
## Patrocinar
426423

‎README.md‎

Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ To install **PHP Asset library**, simply:
4343
composer require josantonius/asset
4444
```
4545

46-
The previous command will only install the necessary files, if you prefer to **download the entire source code** you can use:
46+
The previous command will only install the necessary files,
47+
if you prefer to **download the entire source code** you can use:
4748

4849
```console
4950
composer require josantonius/asset --prefer-source
@@ -63,84 +64,78 @@ Available classes and methods in this library:
6364

6465
```php
6566
new BodyScript(
66-
null|bool $async = null,
67-
null|string $crossorigin = null,
68-
null|bool $defer = null,
69-
null|string $fetchpriority = null,
70-
null|string $integrity = null,
71-
null|bool $nomodule = null,
72-
null|string $nonce = null,
67+
null|bool $async = null,
68+
null|string $crossorigin = null,
69+
null|bool $defer = null,
70+
null|string $fetchpriority = null,
71+
null|string $integrity = null,
72+
null|bool $nomodule = null,
73+
null|string $nonce = null,
7374
null|string $referrerpolicy = null,
74-
null|string $src = null,
75-
null|string $type = null
75+
null|string $src = null,
76+
null|string $type = null
7677
);
7778
```
7879

7980
### Add head script
8081

8182
```php
8283
new HeadScript(
83-
null|bool $async = null,
84-
null|string $crossorigin = null,
85-
null|bool $defer = null,
86-
null|string $fetchpriority = null,
87-
null|string $integrity = null,
88-
null|bool $nomodule = null,
89-
null|string $nonce = null,
84+
null|bool $async = null,
85+
null|string $crossorigin = null,
86+
null|bool $defer = null,
87+
null|string $fetchpriority = null,
88+
null|string $integrity = null,
89+
null|bool $nomodule = null,
90+
null|string $nonce = null,
9091
null|string $referrerpolicy = null,
91-
null|string $src = null,
92-
null|string $type = null
92+
null|string $src = null,
93+
null|string $type = null
9394
);
9495
```
9596

9697
### Add link
9798

9899
```php
99100
new Link(
100-
null|string $as = null,
101-
null|string $crossorigin = null,
102-
null|bool $disabled = null,
103-
null|string $fetchpriority = null,
104-
null|string $href = null,
105-
null|string $hreflang = null,
106-
null|string $imagesizes = null,
107-
null|string $imagesrcset = null,
108-
null|string $integrity = null,
109-
null|string $media = null,
110-
null|string $prefetch = null,
101+
null|string $as = null,
102+
null|string $crossorigin = null,
103+
null|bool $disabled = null,
104+
null|string $fetchpriority = null,
105+
null|string $href = null,
106+
null|string $hreflang = null,
107+
null|string $imagesizes = null,
108+
null|string $imagesrcset = null,
109+
null|string $integrity = null,
110+
null|string $media = null,
111+
null|string $prefetch = null,
111112
null|string $referrerpolicy = null,
112-
null|string $rel = null,
113-
null|string $sizes = null,
114-
null|string $target = null,
115-
null|string $title = null,
116-
null|string $type = null,
113+
null|string $rel = null,
114+
null|string $sizes = null,
115+
null|string $target = null,
116+
null|string $title = null,
117+
null|string $type = null,
117118
);
118119
```
119120

120121
### Print the added scripts for the body
121122

122123
```php
123-
$asset->outputBodyScripts();
124+
$asset->outputBodyScripts(): string
124125
```
125126

126-
**@Return** `string` Added scripts
127-
128127
### Print the added scripts for the head
129128

130129
```php
131-
$asset->outputHeadScripts();
130+
$asset->outputHeadScripts(): string
132131
```
133132

134-
**@Return** `string` Added scripts
135-
136133
### Print the added links
137134

138135
```php
139-
$asset->outputLinks();
136+
$asset->outputLinks(): string
140137
```
141138

142-
**@Return** `string` Added links
143-
144139
## Quick Start
145140

146141
### Using objects
@@ -361,7 +356,8 @@ use Josantonius\Asset\Facades\Asset;
361356

362357
## Tests
363358

364-
To run [tests](tests) you just need [composer](http://getcomposer.org/download/) and to execute the following:
359+
To run [tests](tests) you just need [composer](http://getcomposer.org/download/)
360+
and to execute the following:
365361

366362
```console
367363
git clone https://github.com/josantonius/php-asset.git

0 commit comments

Comments
 (0)