Skip to content

Commit 757fc99

Browse files
committed
update readme, changes and instructions
1 parent feae21a commit 757fc99

File tree

3 files changed

+16
-11
lines changed

3 files changed

+16
-11
lines changed

CHANGES.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@
103103
7.0.1 (Mar 8, 2019)
104104
- Updated Splits refreshing rate.
105105
- Replaced exception log level to error level.
106-
- Improved validation for apikey.
106+
- Improved validation for sdkkey.
107107

108108
7.0.0 (Feb 21, 2019)
109109
- BREAKING CHANGE: Stored Impressions in Queue.

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,16 +54,21 @@ To learn more about Split, contact hello@split.io, or get started with feature f
5454

5555
Split has built and maintains SDKs for:
5656

57+
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
58+
* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
59+
* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://help.split.io/hc/en-us/articles/6495326064397-Angular-utilities)
60+
* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
61+
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
5762
* Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
58-
* Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
63+
* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
64+
* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852-Browser-SDK)
5965
* Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
60-
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
61-
* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
6266
* PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
6367
* Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
64-
* GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
65-
* Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
66-
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
68+
* React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
69+
* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
70+
* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
71+
* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
6772

6873
For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
6974

doc/source/introduction.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ The client depends on the information for features and segments being updated ex
166166
The scripts are configured through a JSON settings file, like the following: ::
167167

168168
{
169-
"apiKey": "some-api-key",
169+
"sdkKey": "some-sdk-key",
170170
"sdkApiBaseUrl": "https://sdk.split.io/api",
171171
"eventsApiBaseUrl": "https://events.split.io/api",
172172
"redisFactory": 'some.redis.factory',
@@ -180,7 +180,7 @@ These are the possible configuration parameters:
180180
+------------------------+------+--------------------------------------------------------+-------------------------------+
181181
| Key | Type | Description | Default |
182182
+========================+======+========================================================+===============================+
183-
| apiKey | str | A valid Split.io API key. | None |
183+
| sdkKey | str | A valid Split.io SDK key. | None |
184184
+------------------------+------+--------------------------------------------------------+-------------------------------+
185185
| sdkApiBaseUrl | str | The SDK API url base | "https://sdk.split.io/api" |
186186
+------------------------+------+--------------------------------------------------------+-------------------------------+
@@ -238,7 +238,7 @@ On the other hand, there is available a python script named ``splitio.bin.synchr
238238
The configuration file is a JSON file with the following fields:
239239

240240
{
241-
"apiKey": "YOUR_API_KEY",
241+
"sdkKey": "YOUR_SDK_KEY",
242242
"redisHost": "REDIS_DNS_OR_IP",
243243
"redisPort": 6379,
244244
"redisDb": 0
@@ -274,7 +274,7 @@ In order to support Redis' Sentinel host discovery, you need to provide a custom
274274
Afterwards you tell the client to use this factory using the config file: ::
275275

276276
{
277-
"apiKey": "some-api-key",
277+
"sdkKey": "some-sdk-key",
278278
"sdkApiBaseUrl": "https://sdk.split.io/api",
279279
"eventsApiBaseUrl": "https://events.split.io/api",
280280
"redisFactory": 'redis_config.my_redis_factory'

0 commit comments

Comments
 (0)