Merge pull request #20 from clue-labs/examples

Update examples and add .gitattributes to exclude dev files from exports

Author: clue

.gitattributes

@@ -0,0 +1,7 @@
+/.gitattributes export-ignore
+/.github/workflows/ export-ignore
+/.gitignore export-ignore
+/examples/ export-ignore
+/phpunit.xml.dist export-ignore
+/phpunit.xml.legacy export-ignore
+/tests/ export-ignore

README.md

@@ -43,9 +43,11 @@ Let's take these projects to the next level together! 🚀
 ## Quickstart example
 
 ```php
-use Clue\Redis\Protocol;
+<?php
 
-$factory = new Protocol\Factory();
+require __DIR__ . '/vendor/autoload.php';
+
+$factory = new Clue\Redis\Protocol\Factory();
 $parser = $factory->createResponseParser();
 $serializer = $factory->createSerializer();
 
@@ -63,6 +65,8 @@ var_dump($reply1->getValueNative()); // string(2) "OK"
 var_dump($reply2->getValueNative()); // string(5) "value"
 ```
 
+See also the [examples](examples/).
+
 ## Usage
 
 ### Factory

example/client.php renamed to examples/client.php

@@ -2,9 +2,7 @@
 
 require __DIR__ . '/../vendor/autoload.php';
 
-use Clue\Redis\Protocol;
-
-$factory = new Protocol\Factory();
+$factory = new Clue\Redis\Protocol\Factory();
 $parser = $factory->createResponseParser();
 $serializer = $factory->createSerializer();
 

example/perf.php renamed to examples/perf.php

@@ -1,11 +1,8 @@
 <?php
 
-use Clue\Redis\Protocol\ProtocolBuffer;
-use Clue\Redis\Protocol\Factory;
-
 require __DIR__ . '/../vendor/autoload.php';
 
-$factory = new Factory();
+$factory = new Clue\Redis\Protocol\Factory();
 $parser = $factory->createResponseParser();
 $serializer = $factory->createSerializer();