Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
add intro
  • Loading branch information
pierrejoye committed Jul 11, 2014
1 parent 13204d2 commit 75db41b
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ Pickle installs PHP extensions easily on all platforms.
[![Code Coverage](https://scrutinizer-ci.com/g/FriendsOfPHP/pickle/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/FriendsOfPHP/pickle/?branch=master)
[![Build Status](https://travis-ci.org/FriendsOfPHP/pickle.svg?branch=master)](https://travis-ci.org/FriendsOfPHP/pickle)


Introduction
------------

Pickle is a new PHP extension installer. It is based on Composer and the plan is to get Composer fully support it. See https://github.com/composer/composer/pull/2898#issuecomment-48439196 for the Composer part of the discussions.

Pickle fully supports existing extension in http://pecl.php.net, running:

```sh
$ bin/pickle install memcache
```

will install the latest version available of the memcache extension.

Windows is fully supported, to install binaries or from the sources (work in progress and given that you have a working build environment in place).

The concept behind Pickle is to ease the life of both developers and end users.

For end users, nothing changes much except that Pickle is based on modern concepts, works with multiple protocols (git or http(s) URLs).

For developers it drastically reduce the release work. Extension meta information are not duplicated anymore. Configure options, files to package etc. are automatically fetched from the sources and the respective files updated during the release process. There is no risk anymore to forget to update the version here or there, or to forget to include a file.

Installation
------------

Expand Down Expand Up @@ -57,6 +79,13 @@ To get extended help for a given command, use:
$ bin/pickle help install
```

To convert a package (based on package.xml current PECL installer), use:

```sh
$ bin/pickle convert /home/pierre/myext/
```

Or run it from the extension source directory.

Contributing
------------
Expand Down

0 comments on commit 75db41b

Please sign in to comment.