Skip to content
This repository has been archived by the owner on Aug 25, 2022. It is now read-only.

Commit

Permalink
Alter the Readme, prepping for a 3.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Taluu committed Aug 29, 2014
1 parent 5f3f511 commit c4e82ef
Showing 1 changed file with 24 additions and 18 deletions.
42 changes: 24 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@
# Elephant.io
Elephant.io
===========
[![Build Status](https://travis-ci.org/Wisembly/elephant.io.png?branch=master)](https://travis-ci.org/Wisembly/elephant.io)

MIT Licenced - Copyright © 2012. Wisembly

## About
Elephant.io is a rough websocket client written in PHP. Its goal is to ease
communications between your PHP application and a real time server using the
websocket transport protocol.

## Licence
This software is distributed under MIT Licence. See LICENCE for more info.

## Requirements
You'll need PHP 5.4 (or more) configured with openssl.
```
___ _,.--.,_ Elephant.io is a rought websocket client
.-~ ~--"~-. ._ "-. written in PHP. Its goal is to ease the
/ ./_ Y "-. \ communications between your PHP Application and
Y :~ ! Y a real-time server.
lq p | / .|
_ \. .-, l / |j Requires PHP 5.4 and openssl, licensed under
()\___) |/ \_/"; ! the MIT License.
\._____.-~\ . ~\. ./
Y_ Y_. "vr"~ T Built-in Engines :
( ( |L j - Socket.io 1.x
[nn[nn..][nn..] - Socket.io 0.x (courtesy of @kbu1564)
~~~~~~~~~~~~~~~~~~~
```

Installation
============
You have multiple ways to install Elephant.io. If you are unsure what to do, go with
[the archive release](#archive-release).

### Archive Release
Archive Release
---------------
1. Download the most recent release from the [release page](https://github.com/Wisembly/elephant.io/releases)
2. Unpack the archive
3. Move the files somewhere in your project

### Development version
Development version
-------------------
1. Install Git
2. `git clone git://github.com/Wisembly/elephant.io.git`

### Via Composer
Via Composer
------------
1. Install composer in your project: `curl -s http://getcomposer.org/installer | php`
2. Create a `composer.json` file (or update it) in your project root:

Expand All @@ -43,6 +49,6 @@ You have multiple ways to install Elephant.io. If you are unsure what to do, go

3. Install via composer : `php composer.phar install`


## Special Thanks
Special Thanks
==============
Special thanks goes to Mark Karpeles who helped the project founder to understand the way websockets works.

0 comments on commit c4e82ef

Please sign in to comment.