Sha256: 3359903ff5b0becd3d89ffc50ffebdf77a773bb159a4386fad23e81d35fe7df1

Contents?: true

Size: 1.26 KB

Versions: 4

Compression:

Stored size: 1.26 KB

Contents

# Wands

A low-level WebSocket library compatible with Ruby's TCPSocket.

## Installation

Install the gem and add to the application's Gemfile by executing:

```bash
bundle add wands
```

If bundler is not being used to manage dependencies, install the gem by executing:

```bash
gem install wands
```

## Usage

### Server

```ruby
server = Wands::WebSocketServer.open('localhost', 2345)

loop do
  client = server.accept
  client.write("Hello World!")
  client.close
end
```

### Client

```ruby
web_socket = Wands::WebSocket.open('localhost', 2345)
web_socket.write("Hello World!")
puts web_socket.gets
web_socket.close
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ledsun/wands.

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
wands-0.4.0 README.md
wands-0.3.0 README.md
wands-0.2.0 README.md
wands-0.1.0 README.md