Skip to content

Commit ad32e23

Browse files
committed
update readme.md
1 parent 534a04e commit ad32e23

File tree

9 files changed

+625
-608
lines changed

9 files changed

+625
-608
lines changed

.editorconfig

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@ root = true
22

33
[*]
44
charset = utf-8
5+
indent_size = 4
6+
indent_style = space
57
end_of_line = lf
68
insert_final_newline = true
7-
indent_style = tab
8-
indent_size = 2
99
trim_trailing_whitespace = true
1010

1111
[*.md]
12-
trim_trailing_whitespace = false
12+
trim_trailing_whitespace = false
13+
14+
[*.yml]
15+
indent_size = 2

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
All notable changes to `php-string-helpers` will be documented in this file
3+
All notable changes to `dvlpr1996/php-string-helpers` will be documented in this file
44

55
## 0.1.0
66

LICENSE.md

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

3-
Copyright (c) dvlpr1996
3+
Copyright (c) 2022 (until present) Nima jahan bakhshian
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,54 @@
1-
# Very short description of the package
1+
# helpful set of PHP string helper functions & utilities class
22

3+
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
35
[![Latest Version on Packagist](https://img.shields.io/packagist/v/dvlpr1996/php-string-helpers.svg?style=flat-square)](https://packagist.org/packages/dvlpr1996/php-string-helpers)
46
[![Total Downloads](https://img.shields.io/packagist/dt/dvlpr1996/php-string-helpers.svg?style=flat-square)](https://packagist.org/packages/dvlpr1996/php-string-helpers)
5-
![GitHub Actions](https://github.com/dvlpr1996/php-string-helpers/actions/workflows/main.yml/badge.svg)
67

7-
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
8+
All function helpers will be enabled by default (if those functions haven't already been defined).
9+
also you can use them as utilities class.
10+
11+
## Requirements
12+
13+
- PHP 8 or higher
814

915
## Installation
1016

1117
You can install the package via composer:
1218

1319
```bash
14-
composer require dvlpr1996/php-string-helpers
20+
.....................................
1521
```
1622

17-
## Usage
23+
## PhpStringHelpers usage
24+
25+
String helper functions are global so usage is like the following:
1826

1927
```php
20-
// Usage description here
28+
echo .......;
2129
```
2230

23-
### Testing
31+
## StrUtility usage
2432

25-
```bash
26-
composer test
33+
String helper methods are static so usage is like the following:
34+
35+
```php
36+
echo .......;
2737
```
2838

29-
### Changelog
39+
## Available methods
40+
41+
## Changelog
3042

3143
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
3244

33-
### Security
45+
## Security
3446

3547
If you discover any security related issues, please email nimajahanbakhshian@gmail.com instead of using the issue tracker.
3648

3749
## Credits
3850

39-
- [nima](https://github.com/dvlpr1996)
51+
- [Nima jahan bakhshian](https://github.com/dvlpr1996)
4052

4153
## License
4254

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"source": "https://github.com/dvlpr1996/php-string-helpers"
2323
},
2424
"require": {
25-
"php": "^7.4|^8.0"
25+
"php": "^8.0"
2626
},
2727
"require-dev": {
2828
"symfony/var-dumper": "^6.0",

0 commit comments

Comments
 (0)