Skip to content

Commit 0b0fc15

Browse files
authored
chore: Update README and fix publishing docs (#9)
1 parent 2adeab3 commit 0b0fc15

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

.github/workflows/publish.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ jobs:
5353
dry_run: ${{ inputs.dry_run }}
5454

5555
- uses: ./.github/actions/publish-docs
56-
if: ${{ steps.release.outputs.releases_created == 'true' }}
5756
with:
5857
token: ${{secrets.GITHUB_TOKEN}}
5958

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,45 @@
1-
LaunchDarkly Server-side AI library for Ruby
1+
LaunchDarkly Server SDK AI library for Ruby
22
==============================================
33

4+
[![Gem Version](https://badge.fury.io/rb/launchdarkly-server-sdk-ai.svg)](http://badge.fury.io/rb/launchdarkly-server-sdk-ai)
5+
6+
[![Quality Control](https://github.com/launchdarkly/ruby-server-sdk-ai/actions/workflows/ci.yml/badge.svg)](https://github.com/launchdarkly/ruby-server-sdk-ai/actions/workflows/ci.yml)
7+
[![RubyDoc](https://img.shields.io/static/v1?label=docs+-+all+versions&message=reference&color=00add8)](https://www.rubydoc.info/gems/launchdarkly-server-sdk-ai)
8+
[![GitHub Pages](https://img.shields.io/static/v1?label=docs+-+latest&message=reference&color=00add8)](https://launchdarkly.github.io/ruby-server-sdk-ai)
9+
10+
LaunchDarkly overview
11+
-------------------------
12+
[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
13+
14+
[![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
15+
16+
Supported Ruby versions
17+
-----------------------
18+
19+
This version of the library has a minimum Ruby version of 3.0.0, or 9.4.0 for JRuby.
20+
21+
Getting started
22+
-----------
23+
24+
Install the gem and add to the application's Gemfile by executing:
25+
26+
$ bundle add launchdarkly-server-sdk-ai
27+
28+
If bundler is not being used to manage dependencies, install the gem by executing:
29+
30+
$ gem install launchdarkly-server-sdk-ai
31+
32+
The provided AI `Client` can be setup as shown below:
33+
34+
```ruby
35+
require 'launchdarkly-server-sdk'
36+
require 'launchdarkly-server-sdk-ai'
37+
38+
sdk_key = ENV['LAUNCHDARKLY_SDK_KEY']
39+
ld_client = LaunchDarkly::LDClient.new(sdk_key)
40+
ai_client = LaunchDarkly::Server::AI::Client.new(ld_client)
41+
```
42+
443
Learn more
544
-----------
645

0 commit comments

Comments
 (0)