Update to v1.2.0

Author: adbario

README.md

@@ -2,7 +2,7 @@
 Easy access to multidimensional arrays with dot notation.
 With dot notation, your code is cleaner and handling deeper arrays is super easy.
 
-This class implements PHP's ArrayAccess class, so Dot object can also be used same way as normal arrays but with dot notation.
+This class implements PHP's ArrayAccess class, so Dot object can also be used the same way as normal arrays with additional dot notation.
 
 With Dot you can change this:
 
@@ -32,6 +32,17 @@ composer require adbario/php-dot-notation
 
 Or just copy the class file Dot.php and handle namespace yourself.
 
+#### With [Composer](https://getcomposer.org/):
+
+```
+composer require adbario/php-dot-notation
+```
+
+#### Manual installation:
+1. Download the latest release
+2. Extract the files into your project
+3. require_once '/path/to/php-dot-notation/src/Dot.php';
+
 ## Usage
 
 This array will be used as a reference on this guide:
@@ -55,35 +66,35 @@ $array = [
 ];
 ```
 
-### Create Dot object
+### Create a Dot object
 
-To start without any data, just create a new Dot object:
+To start with an empty array, just create a new Dot object:
 
 ```php
-$data = new \AdBar\Dot;
+$data = new \Adbar\Dot;
 ```
 
-If you have an array already available, inject it to Dot object:
+If you have an array already available, inject it to the Dot object:
 
 ```php
-$data = new \AdBar\Dot($array);
+$data = new \Adbar\Dot($array);
 ```
 
-Set data after creating Dot object:
+Set an array after creating the Dot object:
 
 ```php
-$data->setData($array);
+$data->setArray($array);
 ```
 
-Set data as a reference, and all changes will be made directly to original array:
+Set an array as a reference, and all changes will be made directly to the original array:
 
 ```php
-$data->setDataAsRef($array);
+$data->setReference($array);
 ```
 
-### Set value
+### Set a value
 
-Set i.e. phone number in 'home' array:
+Set i.e. a phone number in the 'home' array:
 
 ```php
 $data->set('info.home.tel', '09-123-456-789');
@@ -101,21 +112,39 @@ $data->set([
 ]);
 ```
 
-If value already exists, Dot will override it with new value.
+If the value already exists, Dot will override it with a new value.
 
-### Get value
+### Get a value
 
 ```php
 echo $data->get('info.home.address');
 
-// Default value if path doesn't exist
+// Default value if the path doesn't exist
 echo $data->get('info.home.country', 'some default value');
 
 // Array style
 echo $data['info.home.address'];
 ```
 
-### Add value
+Get all the stored values:
+
+```php
+$values = $data->all();
+``
+
+Get a value from a path and remove it:
+
+```php
+$address = $data->pull('home.address');
+```
+
+Get all the stored values and remove them:
+
+```php
+$values = $data->pull();
+```
+
+### Add a value
 
 ```php
 $data->add('info.kids', 'Amy');
@@ -129,7 +158,7 @@ $data->add('info.kids', [
 ]);
 ```
 
-### Check if value exists
+### Check if a value exists
 
 ```php
 if ($data->has('info.home.address')) {
@@ -142,7 +171,7 @@ if (isset($data['info.home.address'])) {
 }
 ```
 
-### Delete value
+### Delete a value
 
 ```php
 $data->delete('info.home.address');
@@ -161,18 +190,12 @@ $data->delete([
 
 ### Clear values
 
-Delete all values from path:
+Delete all the values from a path:
 
 ```php
 $data->clear('info.home');
 ```
 
-If path doesn't exist, create an empty array on it
-
-```php
-$data->clear('info.home.rooms', true);
-```
-
 Clear multiple paths at once:
 
 ```php
@@ -187,32 +210,54 @@ Clear all data:
 $data->clear();
 ```
 
+### Sort the values
+
+You can sort the values of a given path or all the stored values.
+
+Sort the values of a path:
+
+```php
+$kids = $data->sort('info.kids');
+
+// Sort recursively
+$info = $data->sort('info');
+```
+
+Sort all the values
+
+```php
+$sorted = $data->sort();
+
+// Sort recursively
+$sorted = $data->sort();
+```
+
 ### Magic methods
 
 Magic methods can be used to handle single level data (without dot notation). These examples are not using the same data array as examples above.
 
-Set value:
+Set a value:
 
 ```php
 $data->name = 'John';
 ```
 
-Get value:
+Get a value:
 
 ```php
 echo $data->name;
 ```
 
-Check if value exists:
+Check if a value exists:
 
 ```php
 if (isset($data->name)) {
     // Do something...
 }
 ```
 
-Delete value:
+Delete a value:
 
 ```php
 unset($data->name);
-``
+```