You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 29, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+14-1Lines changed: 14 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,20 @@
1
-
# Change log
1
+
# Changelog
2
2
3
3
All notable changes to the LaunchDarkly React Native SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
4
4
5
+
# Note on future releases
6
+
7
+
The LaunchDarkly SDK repositories are being renamed for consistency. This repository is now `react-native-client-sdk` rather than `react-native-client`.
8
+
9
+
The package name will also change. In the 1.0.0 release, it is still `launchdarkly-react-native-client`; in all future releases, it will be `launchdarkly-react-native-client-sdk`.
10
+
11
+
## [1.0.0] - 2019-04-18
12
+
### Changed
13
+
- Android and iOS client versions
14
+
### Fixed
15
+
- Added correct anonymous property
16
+
- Removed dependencies and added caret to peer dependencies
1. Ensure you have `npm` and `react-native-cli` installed.
3
-
2. Clone and setup the `hello-react-native` repo.
4
-
3. Make changes in `node_modules/launchdarkly-react-native-client`.
5
-
4. Test your changes in the root of Hello using either `react-native run-ios` or `react-native run-android`.
1
+
Contributing to the LaunchDarkly Client-side SDK for React Native
2
+
================================================
3
+
4
+
LaunchDarkly has published an [SDK contributor's guide](https://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work. See below for additional information on how to contribute to this SDK.
5
+
6
+
Submitting bug reports and feature requests
7
+
------------------
8
+
9
+
The LaunchDarkly SDK team monitors the [issue tracker](https://github.com/launchdarkly/react-native-client-sdk/issues) in the SDK repository. Bug reports and feature requests specific to this SDK should be filed in this issue tracker. The SDK team will respond to all newly filed issues within two business days.
10
+
11
+
Submitting pull requests
12
+
------------------
13
+
14
+
We encourage pull requests and other contributions from the community. Before submitting pull requests, ensure that all temporary or unintended code is removed. Don't worry about adding reviewers to the pull request; the LaunchDarkly SDK team will add themselves. The SDK team will acknowledge all pull requests within two business days.
15
+
16
+
Build instructions
17
+
------------------
18
+
19
+
### Prerequisites
20
+
21
+
This SDK requires that you have [`npm`](https://www.npmjs.com/) and [`react-native-cli`](https://www.npmjs.com/package/react-native-cli) installed in order to develop with it.
22
+
23
+
### Building and running
24
+
25
+
You can modify and verify changes by developing within the LaunchDarkly React Native SDK sample application (`hello-react-native`).
26
+
27
+
1. In your `react-native-client-sdk` directory, run `npm link`.
28
+
2. Clone and setup the [`hello-react-native`](https://github.com/launchdarkly/hello-react-native) repository.
29
+
3. In your `hello-react-native` directory, run `npm link react-native-client-sdk`.
30
+
4. Test your changes in `hello-react-native` by running either `react-native run-ios` or `react-native run-android` depending on your desired runtime environment.
[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/docs/getting-started) using LaunchDarkly today!
This SDK is compatible with React Native 0.57.7 and is tested in Android 27 and iOS 12.1.
20
14
21
-
asynccomponentDidMount() {
22
-
try {
23
-
let client =newLDClient();
24
-
25
-
let clientConfig =
26
-
{ "mobileKey":"YOUR_MOBILE_KEY",
27
-
"stream":true,
28
-
"offline":false
29
-
};
30
-
31
-
let userConfig = { "key":"user_key" };
15
+
Getting started
16
+
---------------
32
17
33
-
awaitclient.configure(clientConfig, userConfig);
34
-
this.setState({ldClient: client});
35
-
let res =awaitthis.state.ldClient.stringVariation("MY_STRING_FLAG_KEY", "");
36
-
Alert.alert('LD Server Response', String(res));
37
-
} catch(err) {
38
-
console.error(err);
39
-
}
40
-
}
41
-
```
18
+
Refer to the [SDK documentation](https://docs.launchdarkly.com/docs/react-native-sdk-reference#section-getting-started) for instructions on getting started with using the SDK.
42
19
43
20
Learn more
44
21
-----------
45
22
46
-
Check out our [documentation](http://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](http://docs.launchdarkly.com/docs/react-native-sdk-reference).
23
+
Check out our [documentation](https://docs.launchdarkly.com) for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/docs/react-native-sdk-reference).
47
24
48
25
Testing
49
26
-------
@@ -53,7 +30,7 @@ We run integration tests for all our SDKs using a centralized test harness. This
53
30
Contributing
54
31
------------
55
32
56
-
We encourage pull-requests and other contributions from the community. We've also published an [SDK contributor's guide](http://docs.launchdarkly.com/docs/sdk-contributors-guide) that provides a detailed explanation of how our SDKs work.
33
+
We encourage pullrequests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
57
34
58
35
About LaunchDarkly
59
36
-----------
@@ -63,21 +40,10 @@ About LaunchDarkly
63
40
* Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
64
41
* Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
65
42
* Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/docs) for a complete list.
78
44
* Explore LaunchDarkly
79
-
*[launchdarkly.com](http://www.launchdarkly.com/"LaunchDarkly Main Website") for more information
80
-
*[docs.launchdarkly.com](http://docs.launchdarkly.com/"LaunchDarkly Documentation") for our documentation and SDKs
81
-
*[apidocs.launchdarkly.com](http://apidocs.launchdarkly.com/"LaunchDarkly API Documentation") for our API documentation
82
-
*[blog.launchdarkly.com](http://blog.launchdarkly.com/"LaunchDarkly Blog Documentation") for the latest product updates
45
+
*[launchdarkly.com](https://www.launchdarkly.com/"LaunchDarkly Main Website") for more information
46
+
*[docs.launchdarkly.com](https://docs.launchdarkly.com/"LaunchDarkly Documentation") for our documentation and SDK reference guides
47
+
*[apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/"LaunchDarkly API Documentation") for our API documentation
48
+
*[blog.launchdarkly.com](https://blog.launchdarkly.com/"LaunchDarkly Blog Documentation") for the latest product updates
83
49
*[Feature Flagging Guide](https://github.com/launchdarkly/featureflags/"Feature Flagging Guide") for best practices and strategies
0 commit comments