Skip to content
YieldStar AppExchange Adapter
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
.rvmrc
CHANGELOG.md
Gemfile
README.md
Rakefile
yield_star_client.gemspec

README.md

YieldStar Client

Client adapter for the YieldStar AppExchange web service.

Installation

The YieldStar adapter is available on Rubygems and can be installed via:

    gem install 'yield_star_client'

Configuration

You will probably only need to configure the username and password for connecting to the remote service:

    YieldStarClient.configure do |config|
        config.username = 'my_user'
        config.password = 'my_pass'
    end

Sensible defaults are provided for other configuration options. TODO: link to the docs for the rest of the config.

Examples

TODO: More thorough usage examples.

    client = YieldStarClient::Client.new
    client.get_properties('my_client_name')

TODO: Link to docs for more info.

More Information

Something went wrong with that request. Please try again.