|
| 1 | +<!DOCTYPE html> |
| 2 | +<html> |
| 3 | + |
| 4 | + <head> |
| 5 | + <meta charset='utf-8' /> |
| 6 | + <meta http-equiv="X-UA-Compatible" content="chrome=1" /> |
| 7 | + <meta name="description" content="Docker-php : A Docker client in PHP" /> |
| 8 | + |
| 9 | + <link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css"> |
| 10 | + |
| 11 | + <title>Docker-php</title> |
| 12 | + </head> |
| 13 | + |
| 14 | + <body> |
| 15 | + |
| 16 | + <!-- HEADER --> |
| 17 | + <div id="header_wrap" class="outer"> |
| 18 | + <header class="inner"> |
| 19 | + <a id="forkme_banner" href="https://github.com/stage1/docker-php">View on GitHub</a> |
| 20 | + |
| 21 | + <h1 id="project_title">Docker-php</h1> |
| 22 | + <h2 id="project_tagline">A Docker client in PHP</h2> |
| 23 | + |
| 24 | + <section id="downloads"> |
| 25 | + <a class="zip_download_link" href="https://github.com/stage1/docker-php/zipball/master">Download this project as a .zip file</a> |
| 26 | + <a class="tar_download_link" href="https://github.com/stage1/docker-php/tarball/master">Download this project as a tar.gz file</a> |
| 27 | + </section> |
| 28 | + </header> |
| 29 | + </div> |
| 30 | + |
| 31 | + <!-- MAIN CONTENT --> |
| 32 | + <div id="main_content_wrap" class="outer"> |
| 33 | + <section id="main_content" class="inner"> |
| 34 | + <h1> |
| 35 | +<a name="docker-php" class="anchor" href="#docker-php"><span class="octicon octicon-link"></span></a>Docker PHP</h1> |
| 36 | + |
| 37 | +<p><strong>Docker PHP</strong> (for lack of a better name) is a <a href="http://docker.io/">Docker</a> client written in PHP. This library is still a work in progress. Not much is supported yet, but the goal is to reach 100% API support.</p> |
| 38 | + |
| 39 | +<p>The test suite currently passes against the <a href="http://docs.docker.io/en/latest/api/docker_remote_api_v1.9/">Docker Remote API v1.9</a>.</p> |
| 40 | + |
| 41 | +<h2> |
| 42 | +<a name="installation" class="anchor" href="#installation"><span class="octicon octicon-link"></span></a>Installation</h2> |
| 43 | + |
| 44 | +<p>The recommended way to install Docker PHP is of course to use <a href="http://getcomposer.org/">Composer</a>:</p> |
| 45 | + |
| 46 | +<div class="highlight highlight-json"><pre><span class="p">{</span> |
| 47 | + <span class="nt">"require"</span><span class="p">:</span> <span class="p">{</span> |
| 48 | + <span class="nt">"stage1/docker-php"</span><span class="p">:</span> <span class="s2">"@dev"</span> |
| 49 | + <span class="p">}</span> |
| 50 | +<span class="p">}</span> |
| 51 | +</pre></div> |
| 52 | + |
| 53 | +<p><strong>Note</strong>: there is no stable version of Docker PHP yet.</p> |
| 54 | + |
| 55 | +<h2> |
| 56 | +<a name="usage" class="anchor" href="#usage"><span class="octicon octicon-link"></span></a>Usage</h2> |
| 57 | + |
| 58 | +<p>See <a href="doc/usage.md">the documentation</a>.</p> |
| 59 | + |
| 60 | +<h2> |
| 61 | +<a name="unit-tests" class="anchor" href="#unit-tests"><span class="octicon octicon-link"></span></a>Unit Tests</h2> |
| 62 | + |
| 63 | +<p>Setup the test suite using <a href="http://getcomposer.org/">Composer</a>:</p> |
| 64 | + |
| 65 | +<pre><code>$ composer install --dev |
| 66 | +</code></pre> |
| 67 | + |
| 68 | +<p>Run it using <a href="http://phpunit.de/">PHPUnit</a>:</p> |
| 69 | + |
| 70 | +<pre><code>$ bin/phpunit |
| 71 | +</code></pre> |
| 72 | + |
| 73 | +<h2> |
| 74 | +<a name="contributing" class="anchor" href="#contributing"><span class="octicon octicon-link"></span></a>Contributing</h2> |
| 75 | + |
| 76 | +<p>Here are a few rules to follow in order to ease code reviews, and discussions before maintainers accept and merge your work.</p> |
| 77 | + |
| 78 | +<ul> |
| 79 | +<li>You <strong>MUST</strong> follow the <a href="http://www.php-fig.org/psr/1/">PSR-1</a> and <a href="http://www.php-fig.org/psr/2/">PSR-2</a>.</li> |
| 80 | +<li>You <strong>MUST</strong> run the test suite.</li> |
| 81 | +<li>You <strong>MUST</strong> write (or update) unit tests.</li> |
| 82 | +<li>You <strong>SHOULD</strong> write documentation.</li> |
| 83 | +</ul><p>Please, write <a href="http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">commit messages that make sense</a>, and <a href="http://git-scm.com/book/en/Git-Branching-Rebasing">rebase your branch</a> before submitting your Pull Request.</p> |
| 84 | + |
| 85 | +<p>One may ask you to <a href="http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html">squash your commits</a> too. This is used to "clean" your Pull Request before merging it (we don't want commits such as <code>fix tests</code>, <code>fix 2</code>, <code>fix 3</code>, etc.).</p> |
| 86 | + |
| 87 | +<p>Also, when creating your Pull Request on GitHub, you <strong>MUST</strong> write a description which gives the context and/or explains why you are creating it.</p> |
| 88 | + |
| 89 | +<p>Thank you!</p> |
| 90 | + |
| 91 | +<h2> |
| 92 | +<a name="credits" class="anchor" href="#credits"><span class="octicon octicon-link"></span></a>Credits</h2> |
| 93 | + |
| 94 | +<p>This README heavily inspired by <a href="https://github.com/willdurand/Negotiation">willdurand/Negotiation</a> by <a href="https://github.com/willdurand" class="user-mention">@willdurand</a>. This guy is pretty awesome.</p> |
| 95 | + |
| 96 | +<h2> |
| 97 | +<a name="projects" class="anchor" href="#projects"><span class="octicon octicon-link"></span></a>Projects</h2> |
| 98 | + |
| 99 | +<p>Projects known to be using docker-php:</p> |
| 100 | + |
| 101 | +<ul> |
| 102 | +<li> |
| 103 | +<a href="https://github.com/jolicode/JoliCi">JoliCi</a>, Run your tests on different and isolated stacks</li> |
| 104 | +</ul><h2> |
| 105 | +<a name="license" class="anchor" href="#license"><span class="octicon octicon-link"></span></a>License</h2> |
| 106 | + |
| 107 | +<p>The MIT License (MIT)</p> |
| 108 | + |
| 109 | +<p>Copyright (c) 2013 Geoffrey Bachelet <a href=" mailto:[email protected]" >[email protected]</a></p> |
| 110 | + |
| 111 | +<p>Permission is hereby granted, free of charge, to any person obtaining a copy |
| 112 | +of this software and associated documentation files (the "Software"), to deal |
| 113 | +in the Software without restriction, including without limitation the rights |
| 114 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 115 | +copies of the Software, and to permit persons to whom the Software is |
| 116 | +furnished to do so, subject to the following conditions:</p> |
| 117 | + |
| 118 | +<p>The above copyright notice and this permission notice shall be included in |
| 119 | +all copies or substantial portions of the Software.</p> |
| 120 | + |
| 121 | +<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 122 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 123 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 124 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 125 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 126 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
| 127 | +THE SOFTWARE.</p> |
| 128 | + </section> |
| 129 | + </div> |
| 130 | + |
| 131 | + <!-- FOOTER --> |
| 132 | + <div id="footer_wrap" class="outer"> |
| 133 | + <footer class="inner"> |
| 134 | + <p class="copyright">Docker-php maintained by <a href="https://github.com/stage1">stage1</a></p> |
| 135 | + <p>Published with <a href="http://pages.github.com">GitHub Pages</a></p> |
| 136 | + </footer> |
| 137 | + </div> |
| 138 | + |
| 139 | + |
| 140 | + |
| 141 | + </body> |
| 142 | +</html> |
0 commit comments