Sha256: 94845a769675f8a35e1201a6b9745fbe0b95432505d5c828e5499588347679d8

Contents?: true

Size: 1.95 KB

Versions: 1

Compression:

Stored size: 1.95 KB

Contents

# Tsclient

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

Client library wrapping the [Tailscale localapi][localapi]. This lets you do things like find out the identity of another machine talking to you on the tailnet, or interrogate the current machine's info.

[localapi]: https://github.com/tailscale/tailscale/blob/main/ipn/localapi/localapi.go

## Installation

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

    $ bundle add tsclient

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

    $ gem install tsclient

## Usage

TODO.

## 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/caius/tsclient. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/caius/tsclient/blob/main/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Tsclient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/caius/tsclient/blob/main/CODE_OF_CONDUCT.md).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
tsclient-0.0.1 README.md