Skip to content

Commit 7603492

Browse files
committed
Install section added
1 parent abd5f36 commit 7603492

File tree

4 files changed

+19
-9
lines changed

4 files changed

+19
-9
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Once installed with `composer`, the global functions are accessable from **every
1212
dump( 'any content' );
1313
```
1414

15-
If a function with the same name already exists in the list of your project's defined functions ( built-in and user-defined ), it will simply not be registered in your environment. Therefore, no conflicts will appear.
15+
If a function with the same name already exists in the list of your project's defined functions ( built-in and user-defined ), it will simply not be registered in your environment. Therefore, **no conflicts** will ever appear.
1616

1717
Nevertheless, every function is still accessable it in a static way with the appropriate use-statement:
1818

@@ -24,9 +24,13 @@ use CNZ\Helpers\Util as util;
2424

2525
util::dump( 'any content' );
2626
```
27+
28+
#### Unit Tests
29+
30+
With every commit to the repository, every function is automatically tested against a number of unit-tests and PHP Versions.
2731
# Install
2832

29-
To install the latest clausnz/php-helper library, simply add the following lines to your composer.json and run a `composer update`:
33+
To install the latest clausnz/php-helper library, simply add the following lines to your `composer.json` and run a `composer update`:
3034

3135
#### Example
3236
```json
@@ -50,7 +54,7 @@ Also make sure to require your composer autoload file:
5054
require __DIR__ . '/vendor/autoload.php';
5155
```
5256

53-
Now the new global PHP functions are immediately available everywhere in your code. To also access the static functions in the helper classes, add an approbiate use statement to your file:
57+
After installation, the new global PHP functions are immediately available everywhere in your code. To also access the ( almost identical ) static functions in the helper classes, add an approbiate use statement to your file:
5458

5559
#### Example
5660
```php
@@ -62,7 +66,6 @@ if( dev::isIphone() ) {
6266
// Do something here
6367
}
6468
```
65-
6669
# Available PHP Functions
6770

6871
## Table of Contents

doc/About.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Once installed with `composer`, the global functions are accessable from **every
1212
dump( 'any content' );
1313
```
1414

15-
If a function with the same name already exists in the list of your project's defined functions ( built-in and user-defined ), it will simply not be registered in your environment. Therefore, no conflicts will appear.
15+
If a function with the same name already exists in the list of your project's defined functions ( built-in and user-defined ), it will simply not be registered in your environment. Therefore, **no conflicts** will ever appear.
1616

1717
Nevertheless, every function is still accessable it in a static way with the appropriate use-statement:
1818

@@ -24,3 +24,7 @@ use CNZ\Helpers\Util as util;
2424

2525
util::dump( 'any content' );
2626
```
27+
28+
#### Unit Tests
29+
30+
With every commit to the repository, every function is automatically tested against a number of unit-tests and PHP Versions.

doc/Install.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install
22

3-
To install the latest clausnz/php-helper library, simply add the following lines to your composer.json and run a `composer update`:
3+
To install the latest clausnz/php-helper library, simply add the following lines to your `composer.json` and run a `composer update`:
44

55
#### Example
66
```json
@@ -24,7 +24,7 @@ Also make sure to require your composer autoload file:
2424
require __DIR__ . '/vendor/autoload.php';
2525
```
2626

27-
Now the new global PHP functions are immediately available everywhere in your code. To also access the static functions in the helper classes, add an approbiate use statement to your file:
27+
After installation, the new global PHP functions are immediately available everywhere in your code. To also access the ( almost identical ) static functions in the helper classes, add an approbiate use statement to your file:
2828

2929
#### Example
3030
```php
@@ -36,5 +36,4 @@ if( dev::isIphone() ) {
3636
// Do something here
3737
}
3838
```
39-
4039

doc/template/About.tmpl.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Once installed with `composer`, the global functions are accessable from **every
1212
dump( 'any content' );
1313
```
1414

15-
If a function with the same name already exists in the list of your project's defined functions ( built-in and user-defined ), it will simply not be registered in your environment. Therefore, no conflicts will appear.
15+
If a function with the same name already exists in the list of your project's defined functions ( built-in and user-defined ), it will simply not be registered in your environment. Therefore, **no conflicts** will ever appear.
1616

1717
Nevertheless, every function is still accessable it in a static way with the appropriate use-statement:
1818

@@ -24,3 +24,7 @@ use CNZ\Helpers\Util as util;
2424

2525
util::dump( 'any content' );
2626
```
27+
28+
#### Unit Tests
29+
30+
With every commit to the repository, every function is automatically tested against a number of unit-tests and PHP Versions.

0 commit comments

Comments
 (0)