Updated docs (#158)

Author: GrahamCampbell

.github/CONTRIBUTING.md

@@ -27,5 +27,6 @@ Then run [PHPUnit](https://phpunit.de/):
 $ vendor/bin/phpunit
 ```
 
+* A script `test-git-version.sh` is available in repository to test gitlib against many git versions.
 * The tests will be automatically run by [Travis CI](https://travis-ci.org/) against pull requests.
 * We also have [StyleCI](https://styleci.io/) setup to automatically fix any code style issues.

README.md

@@ -5,37 +5,16 @@ Gitlib for Gitonomy
 [![StyleCI](https://github.styleci.io/repos/5709354/shield?branch=master)](https://github.styleci.io/repos/5709354)
 [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
-This library provides methods to access Git repository from PHP.
+This library provides methods to access Git repository from PHP 5.6 or 7.
 
 It makes shell calls, which makes it less performant than any solution.
 
 Anyway, it's convenient and don't need to build anything to use it. That's how we love it.
 
-## Documentation
-
-* [Overview](doc/index.md)
-* [Debug](doc/debug.md)
-* [Development](doc/development.md)
-* [Installation](doc/installation.md)
-* API
-  + [Admin](doc/api/admin.md)
-  + [Blame](doc/api/blame.md)
-  + [Blob](doc/api/blob.md)
-  + [Branch](doc/api/branch.md)
-  + [Commit](doc/api/commit.md)
-  + [Diff](doc/api/diff.md)
-  + [Hooks](doc/api/hooks.md)
-  + [Log](doc/api/log.md)
-  + [References](doc/api/references.md)
-  + [Repository](doc/api/repository.md)
-  + [Revision](doc/api/revision.md)
-  + [Tree](doc/api/tree.md)
-  + [Working Copy](doc/api/workingcopy.md)
-
-## Quick Start
-
-You can install gitlib using [Composer](https://getcomposer.org/). Simply
-require the version you need:
+Quick Start
+-----------
+
+You can install gitlib using [Composer](https://getcomposer.org/). Simply require the version you need:
 
 ```bash
 $ composer require gitonomy/gitlib
@@ -51,7 +30,42 @@ or edit your `composer.json` file by hand:
 }
 ```
 
-## For Enterprise
+Example Usage
+-------------
+
+```php
+<?php
+
+use Gitonomy\Git\Repository;
+
+$repository = new Repository('/path/to/repository');
+
+foreach ($repository->getReferences()->getBranches() as $branch) {
+    echo "- ".$branch->getName().PHP_EOL;
+}
+
+$repository->run('fetch', ['--all']);
+```
+
+API Documentation
+-----------------
+
++ [Admin](doc/admin.md)
++ [Blame](doc/blame.md)
++ [Blob](doc/blob.md)
++ [Branch](doc/branch.md)
++ [Commit](doc/commit.md)
++ [Diff](doc/diff.md)
++ [Hooks](doc/hooks.md)
++ [Log](doc/log.md)
++ [References](doc/references.md)
++ [Repository](doc/repository.md)
++ [Revision](doc/revision.md)
++ [Tree](doc/tree.md)
++ [Working Copy](doc/workingcopy.md)
+
+For Enterprise
+--------------
 
 Available as part of the Tidelift Subscription
 

doc/api/admin.md doc/admin.mddoc/api/admin.md renamed to doc/admin.md

@@ -11,7 +11,7 @@ $blame = $repository->getBlame('master', 'README.md');
 
 foreach ($blame->getLines() as $lineNumber => $line) {
     $commit = $line->getCommit();
-    echo $lineNumber.': '.$line->getContent()."    - ".$commit->getAuthorName()."\n";
+    echo $lineNumber.': '.$line->getContent().'    - '.$commit->getAuthorName().PHP_EOL;
 }
 ```
 

doc/api/blame.md doc/blame.mddoc/api/blame.md renamed to doc/blame.md

@@ -37,8 +37,8 @@ You can also test if *Blob* is a text of a binary file:
 
 ```php
 if ($blob->isText()) {
-    echo $blob->getContent(), "\n";
+    echo $blob->getContent(), PHP_EOL;
 } elseif ($blob->isBinary()) {
-    echo "File is binary\n";
+    echo 'File is binary', PHP_EOL;
 }
 ```

doc/api/blob.md doc/blob.mddoc/api/blob.md renamed to doc/blob.md

@@ -31,7 +31,7 @@ For example, if you want to display all parents, starting from a commit:
 
 ```php
 function displayLog(Gitonomy\Git\Commit $commit) {
-    echo '- '.$commit->getShortMessage()."\n";
+    echo '- '.$commit->getShortMessage().PHP_EOL;
     foreach ($commit->getParents() as $parent) {
         displayLog($parent);
     }
@@ -155,10 +155,10 @@ Here is a very straightforward example:
 ```php
 $last = $commit->getLastModification('README');
 
-echo "Last README modification:\n";
-echo"  Author: ".$last->getAuthorName()."\n";
-echo"    Date: ".$last->getAuthorDate()->format('d/m/Y')."\n";
-echo" Message: ".$last->getMessage();
+echo 'Last README modification'.PHP_EOL;
+echo '  Author: '.$last->getAuthorName().PHP_EOL;
+echo '    Date: '.$last->getAuthorDate()->format('d/m/Y').PHP_EOL;
+echo ' Message: '.$last->getMessage();
 ```
 
 Find every branches containing a commit

doc/api/branch.md doc/branch.mddoc/api/branch.md renamed to doc/branch.md

@@ -32,11 +32,11 @@ represents the modifications for a single file.
 
 ```php
 $files = $diff->getFiles();
-echo sprintf("%s files modified", count($files));
+echo sprintf('%s files modified%s', count($files), PHP_EOL);
 
 foreach ($files as $fileDiff) {
-    echo sprintf("Old name: (%s) %s\n", $fileDiff->getOldMode(), $fileDiff->getOldName());
-    echo sprintf("New name: (%s) %s\n", $fileDiff->getNewMode(), $fileDiff->getNewName());
+    echo sprintf('Old name: (%s) %s%s', $fileDiff->getOldMode(), $fileDiff->getOldName(), PHP_EOL);
+    echo sprintf('New name: (%s) %s%s', $fileDiff->getNewMode(), $fileDiff->getNewName(), PHP_EOL);
 }
 ```
 
@@ -86,11 +86,11 @@ foreach ($changes as $change) {
     foreach ($lines as $data) {
         list ($type, $line) = $data;
         if ($type === FileChange::LINE_CONTEXT) {
-            echo ' '.$line."\n";
+            echo ' '.$line.PHP_EOL;
         } elseif ($type === FileChange::LINE_ADD) {
-            echo '+'.$line."\n";
+            echo '+'.$line.PHP_EOL;
         } else {
-            echo '-'.$line."\n";
+            echo '-'.$line.PHP_EOL;
         }
     }
 }
@@ -99,6 +99,6 @@ foreach ($changes as $change) {
 To get line numbers, use the range methods:
 
 ```php
-echo sprintf("Previously from line %s to %s\n", $change->getOldRangeStart(), $change->getOldRangeEnd());
-echo sprintf("Now from line %s to %s\n", $change->getNewRangeStart(), $change->getNewRangeEnd());
+echo sprintf('Previously from line %s to %s%s', $change->getOldRangeStart(), $change->getOldRangeEnd(), PHP_EOL);
+echo sprintf('Now from line %s to %s%s', $change->getNewRangeStart(), $change->getNewRangeEnd(), PHP_EOL);
 ```