Skip to content

Commit

Permalink
Add content to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
rask committed Jun 6, 2016
1 parent a855a3d commit 3bfabea
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ key-value storage written in PHP.

Originally the idea was to create a Memcached clone using just PHP as an experiment.

You can read the "manual" over at [rask.github.io/caphpe](https://rask.github.io/caphpe).

## Installation

### Requirements
Expand All @@ -15,6 +17,8 @@ Make sure you have a relatively new PHP CLI installation available. Caphpe has b
developed with PHP5.5+ in mind but is currently only tested on PHP 7. Please try it
out and report if something does not work.

(Later on Caphpe will move to support only PHP7+ environments.)

### Using the built PHAR

1. Download `caphpe.phar`
Expand All @@ -28,6 +32,17 @@ out and report if something does not work.
3. Install dependencies using `composer install`
4. Run `bin/caphpe`.

### Build PHAR for yourself

First clone this repo and fetch Composer dependencies, then run

$ box build

If you want to build a specific version, you can checkout a tag:

$ git checkout 0.1.0
$ box build

## Usage

### Starting a Caphpe instance
Expand Down

0 comments on commit 3bfabea

Please sign in to comment.