Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ajacksified committed Dec 19, 2011
1 parent a9dc2d8 commit 3cc0f2c
Showing 1 changed file with 43 additions and 40 deletions.
83 changes: 43 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,27 @@
Alchemy Websockets
=============

A websocket server built in C# to be extremely efficient and scalable over high
numbers of connections.
##Status

**Version 2.0.0**

### Protocol Support

Alchemy websockets supports:

* (✓) hixie-76 (hybi00)
* (✓) hybi-10
* (✓) hybi-17 (official protocol)


An extremely efficient C# WebSocket server.

You can download the client javascript library at [alchemy-websockets-client-library](https://github.com/Olivine-Labs/Alchemy-Websockets-Client-Library)

Documentation: [docs.alchemywebsockets.net](http://docs.alchemywebsockets.net/)
Documentation: [olivinelabs.com/Alchemy-Websockets/](http://olivinelabs.com/Alchemy-Websockets/)

## Usage

Usage
-------
Alchemy Websockets is a Visual Studio 2010 project. It can be loaded in the free
Visual C# Express and Monodevelop as well (and potentially other compatible IDEs.)

Expand All @@ -22,39 +33,32 @@ An example application can be seen on [alchemy-websockets-example](https://githu

Example:

static void Main(string[] args)
{
var aServer = new WSServer(8100, IPAddress.Any)
{
DefaultOnReceive = new OnEventDelegate(OnReceive),
DefaultOnSend = new OnEventDelegate(OnSend),
DefaultOnConnect = new OnEventDelegate(OnConnect),
DefaultOnConnected = new OnEventDelegate(OnConnected),
DefaultOnDisconnect = new OnEventDelegate(OnDisconnect),
TimeOut = new TimeSpan(0, 5, 0)
};

aServer.Start();
}

static void OnConnected(UserContext aContext)
{
Console.WriteLine("Client Connection From : " + aContext.ClientAddress.ToString());
}

//...etc

Documentation
-------------
Check out our documentaion at [http://olivinelabs.com/Alchemy-Websockets](http://olivinelabs.com/Alchemy-Websockets)

Status
------
Alchemy websockets supports:
```csharp
static void Main(string[] args)
{
var aServer = new WSServer(8100, IPAddress.Any)
{
DefaultOnReceive = new OnEventDelegate(OnReceive),
DefaultOnSend = new OnEventDelegate(OnSend),
DefaultOnConnect = new OnEventDelegate(OnConnect),
DefaultOnConnected = new OnEventDelegate(OnConnected),
DefaultOnDisconnect = new OnEventDelegate(OnDisconnect),
TimeOut = new TimeSpan(0, 5, 0)
};

* (✓) hixie-76 (hybi00)
* (✓) hybi-10
* (✓) hybi-17 (official protocol)
aServer.Start();
}

static void OnConnected(UserContext aContext)
{
Console.WriteLine("Client Connection From : " + aContext.ClientAddress.ToString());
}

//...etc
```

## Documentation
Check out our documentation at [http://olivinelabs.com/Alchemy-Websockets](http://olivinelabs.com/Alchemy-Websockets)


This covers Chrome current, beta, and alpha channels; Firefox
Expand All @@ -64,8 +68,7 @@ support natively.

[Browser Support List](http://en.wikipedia.org/wiki/WebSocket#Browser_support)

License
-------
Copyright 2011, Olivine Labs, LLC.
## License
Licensed under [LGPL](http://www.gnu.org/licenses/lgpl.html) and
[MIT](http://www.opensource.org/licenses/mit-license.php).
Copyright 2011, Olivine Labs, LLC.

0 comments on commit 3cc0f2c

Please sign in to comment.