Contents

# RSocks

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/r_socks`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'r_socks'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install r_socks

## Usage

#### use ENV set auth username and password

by default both user and password is: `default`

```
export RSOCKS_USER=some_user_name
export RSOCKS_PASSWORD=some_password
```


run server

```ruby
require 'r_socks'

server = RSocks::TcpServer.new('127.0.0.1', 8081)

server.config.auth_method = :password

server.run!
```


## 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 tags, 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/nickoan/r_socks.

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
r_socks-0.1.6	README.md
r_socks-0.1.5	README.md
r_socks-0.1.4	README.md
r_socks-0.1.3	README.md
r_socks-0.1.2	README.md
r_socks-0.1.1	README.md