Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 5.42 KB

README.md

File metadata and controls

98 lines (68 loc) · 5.42 KB
Raw

Split GO SDK

build workflow PkgGoDev Documentation

Overview

This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via feature flags to manage your complete customer experience.

Twitter Follow

Compatibility

This SDK is compatible with Go 1.18.

Getting started

Below is a simple example that describes the instantiation and most basic usage of our SDK:

Run go get github.com/splitio/go-client/

package main

import (
    "github.com/splitio/go-client/v6/splitio/client"
    "github.com/splitio/go-client/v6/splitio/conf"
)

func main() {
    cfg := conf.Default()
    factory, err := client.NewSplitFactory("YOUR_SDK_KEY", cfg)
    if err != nil {
        // SDK initialization error
    }

    client := factory.Client()

    err = client.BlockUntilReady(10)
    if err != nil {
        // SDK timeout error
    }

    treatment := client.Treatment("CUSTOMER_ID", "FEATURE_FLAG_NAME", nil)
    if treatment == "on" {
        // insert code here to show on treatment
    } else if treatment == "off" {
        // insert code here to show off treatment
    } else {
        // insert your control treatment code here
    }
}

Please refer to our official docs) to learn about all the functionality provided by our SDK and the configuration options available for tailoring it to your current application setup.

Submitting issues

The Split team monitors all issues submitted to this issue tracker. We encourage you to use this issue tracker to submit any bug reports, feedback, and feature enhancements. We'll do our best to respond in a timely manner.

Contributing

Please see Contributors Guide to find all you need to submit a Pull Request (PR).

License

Licensed under the Apache License, Version 2.0. See: Apache License.

About Split

Split is the leading Feature Delivery Platform for engineering teams that want to confidently deploy feature flags as fast as they can develop them. Split’s fine-grained management, real-time monitoring, and data-driven experimentation ensure that new feature flags will improve the customer experience without breaking or degrading performance. Companies like Twilio, Salesforce, GoDaddy and WePay trust Split to power their feature delivery.

To learn more about Split, contact hello@split.io, or get started with feature flags for free at Split.

Split has built and maintains SDKs for:

For a comprehensive list of open source projects visit our Github page.

Learn more about Split:

Visit split.io/product for an overview of Split, or visit our documentation at help.split.io for more detailed information.