- update README.md

- change some methods name

Author: karster

README.md

@@ -1,5 +1,48 @@
 # Yii2 string helpers
 
+[![Build Status](https://travis-ci.org/hyperia-sk/yii2-string-helpers.svg)](https://travis-ci.org/hyperia-sk/yii2-secure-headers) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/hyperia-sk/yii2-string-helpers/master/LICENSE)
+
+> Extension for Yii2 string helpers
+
+## Installation
+
+The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
+
+Either run
+
+```shell
+composer require hyperia/yii2-string-helpers:"^1.0"
+```
+
+or add
+
+```
+"hyperia/yii2-string-helpers": "^1.0"
+```
+
+to the require section of your composer.json.
+
+## Available Methods
+
+- contains
+- isLonger
+- isShorter
+- length
+- toLower
+- toUpper
+- firstCharToUpper
+- removeAccent
+
+## Usage
+
+```php
+use hyperia\helpers\StringHelper;
+
+echo StringHelper::isLonger('This is test string', 12); // 1
+echo StrinhHelper::removeAccent('Ħí ŧħə®ë, юßť å test!'); // Hi there, jusst a test!
+echo StringHelper::contains('is', 'This is test string'); // 1
+```
+
 ## Tests
 
 change `phpunit.xml.dist` to `phpunit.xml` and run

src/StringHelper.php

@@ -71,7 +71,7 @@ public static function length($string, $encoding = 'UTF-8')
      * @param string $encoding
      * @return string
      */
-    public static function strtolower($string, $encoding = 'UTF-8')
+    public static function toLower($string, $encoding = 'UTF-8')
     {
         return mb_strtolower($string, $encoding);
     }
@@ -84,7 +84,7 @@ public static function strtolower($string, $encoding = 'UTF-8')
      * @param string $encoding
      * @return string
      */
-    public static function strtoupper($string, $encoding = 'UTF-8')
+    public static function toUpper($string, $encoding = 'UTF-8')
     {
         return mb_strtoupper($string, $encoding);
     }
@@ -97,13 +97,13 @@ public static function strtoupper($string, $encoding = 'UTF-8')
      * @param string $encoding
      * @return string
      */
-    public static function ucfirst($string, $encoding = 'UTF-8')
+    public static function firstCharToUpper($string, $encoding = 'UTF-8')
     {
         $strlen = static::length($string, $encoding);
         $firstChar = mb_substr($string, 0, 1, $encoding);
         $then = mb_substr($string, 1, $strlen - 1, $encoding);
 
-        return mb_strtoupper($firstChar, $encoding) . $then;
+        return static::toUpper($firstChar, $encoding) . $then;
     }
 
     /**

tests/StringHelperTest.php

@@ -122,25 +122,25 @@ public function testLength($test_string)
     /**
      * @dataProvider testStringProvider
      */
-    public function testStrtolower($test_string)
+    public function testToLower($test_string)
     {
-        $this->assertEquals('ščťýľárt4569', StringHelper::strtolower($test_string));
+        $this->assertEquals('ščťýľárt4569', StringHelper::toLower($test_string));
     }
 
     /**
      * @dataProvider testStringProvider
      */
-    public function testStrtoupper($test_string)
+    public function testToUpper($test_string)
     {
-        $this->assertEquals('ŠČŤÝĽÁRT4569', StringHelper::strtoupper($test_string));
+        $this->assertEquals('ŠČŤÝĽÁRT4569', StringHelper::toUpper($test_string));
     }
 
     /**
      * @dataProvider testStringProvider
      */
-    public function testUcfirst($test_string)
+    public function testFirstCharToUpper($test_string)
     {
-        $this->assertEquals('ŠčŤýĽÁrT4569', StringHelper::ucfirst($test_string));
+        $this->assertEquals('ŠčŤýĽÁrT4569', StringHelper::firstCharToUpper($test_string));
     }
 
     public function testStringProvider()