docs(README): List supported environments, add badges, and more #136
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,20 +3,22 @@ | |
| </h3> | ||
|
|
||
| <p align="center"> | ||
| This repository houses the official JavaScript SDK for use with Optimizely X Full Stack. | ||
| </p> | ||
|
|
||
| Optimizely X Full Stack is A/B testing and feature management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/products/full-stack/, or see the [documentation](https://developers.optimizely.com/x/solutions/sdks/reference/index.html?language=node). | ||
|
|
||
| ## Packages | ||
|
|
||
| This repository is a monorepo that we manage using [Lerna](https://github.com/lerna/lerna). Only one package lives here currently, but that may change in the future. | ||
|
|
||
| | Package | Version | Docs | Description | | ||
| | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | ||
| | [`@optimizely/optimizely-sdk`](/packages/optimizely-sdk) | [](https://www.npmjs.com/package/@optimizely/optimizely-sdk) | [](https://developers.optimizely.com/x/solutions/sdks/reference/?language=javascript) | The Optimizely SDK | | ||
|
|
||
| ## About | ||
|
|
||
| `@optimizely/optimizely-sdk` is developed and maintained by [Optimizely](https://optimizely.com) and many [contributors](https://github.com/optimizely/javascript-sdk/graphs/contributors). If you're interested in learning more about what Optimizely X Full Stack can do for your company, please [get in touch](mailto:[email protected])! | ||
|
|
||
|
|
||
| ### Contributing | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,66 @@ | ||
| # JavaScript SDK for Optimizely X Full Stack | ||
| [](https://www.npmjs.com/package/@optimizely/optimizely-sdk) | ||
| [](https://www.npmjs.com/package/@optimizely/optimizely-sdk) | ||
| [](https://travis-ci.org/optimizely/javascript-sdk) | ||
| [](https://coveralls.io/github/optimizely/javascript-sdk) | ||
| [](https://choosealicense.com/licenses/apache-2.0/) | ||
|
|
||
|
|
||
| Optimizely X Full Stack is A/B testing and feature management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at the [landing page](https://www.optimizely.com/products/full-stack/), or see the [documentation](https://developers.optimizely.com/x/solutions/sdks/reference/index.html?language=node). | ||
|
|
||
| This directory contains the source code for the JavaScript SDK, which is usable in Node.js, browsers, and beyond. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| Ensure the SDK supports all of the platforms you're targeting. In particular, we support any ES5-compliant JavaScript environment, including | ||
| - Node.js >= 4.0.0. By extension, environments like AWS Lambda, Google Cloud Functions, and Auth0 Webtasks are supported as well. Older Node.js releases likely work too (try `npm test` to validate for yourself), but are not formally supported. | ||
|
|
||
| - [Web browsers](https://caniuse.com/#feat=es5) | ||
| - [Cloudflare Workers](https://developers.cloudflare.com/workers/) and [Fly](https://fly.io/), both of which are powered by V8. | ||
| - Anywhere else you can think of that might embed a JavaScript engine. The sky is the limit; experiment everywhere! 🚀 | ||
|
|
||
| Once you've validated that the SDK supports the platforms you're targeting, fetch the package from [NPM](https://www.npmjs.com/package/@optimizely/optimizely-sdk). Using `npm`: | ||
|
|
||
| ``` | ||
| npm install --save @optimizely/optimizely-sdk | ||
| ``` | ||
|
|
||
| ### Usage | ||
| See the Optimizely X Full Stack [developer documentation](http://developers.optimizely.com/server/reference/index.html) to learn how to set up your first JavaScript project and use the SDK. | ||
|
|
||
| Regarding `EventDispatcher`s: In Node.js and browser environments, the default `EventDispatcher` is powered by the [`http/s`](https://nodejs.org/api/http.html) modules and by [`XMLHttpRequest`](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest#Browser_compatibility), respectively. In all other environments, you must supply your own `EventDispatcher`. | ||
|
|
||
| ### Migrating from 1.x.x | ||
|
|
||
| This version represents a major version change and, as such, introduces some breaking changes: | ||
|
|
||
| - The Node.js SDK is now combined with the JavaScript SDK. We now have just one package, `@optimizely/optimizely-sdk`, that works in many JavaScript environments. | ||
|
|
||
| - We no longer support Node.js < 4.0.0, which [reached end-of-life](https://github.com/nodejs/Release#end-of-life-releases) 2016-12-31. | ||
|
There was a problem hiding this comment. Super nit: by 2016-12-31 would make it true for both 0.10 and 0.12. Reads kind of weird though. There was a problem hiding this comment. hah, yeah. Maybe
|
||
|
|
||
| - You will no longer be able to pass in `revenue` value as a stand-alone argument to the `track` call. Instead you will need to pass it as an entry in the [`eventTags`](https://developers.optimizely.com/x/solutions/sdks/reference/index.html?language=javascript#event-tags). | ||
|
|
||
| ### Feature Management access | ||
|
|
||
| To access Feature Management in the Optimizely web application, please contact your Optimizely account executive. | ||
|
|
||
| ## Contributing | ||
| This information is relevant only if you plan on contributing to the SDK itself. | ||
|
|
||
| ```sh | ||
| # Prerequisite: Install dependencies. | ||
| npm install | ||
|
|
||
| # Run unit tests with mocha. | ||
| npm test | ||
|
|
||
| # Run unit tests in many browsers, currently via BrowserStack. | ||
| # For this to work, the following environment variables must be set: | ||
| # - BROWSER_STACK_USERNAME | ||
| # - BROWSER_STACK_PASSWORD | ||
| npm run test-xbrowser | ||
| ``` | ||
|
|
||
| [.travis.yml](/.travis.yml) contains the definitions for `BROWSER_STACK_USERNAME` and `BROWSER_STACK_ACCESS_KEY` used in CI. These values are Optimizely's BrowserStack credentials, encrypted with our Travis CI public key. These creds can be rotated by following [these docs](https://docs.travis-ci.com/user/environment-variables/#Defining-encrypted-variables-in-.travis.yml). | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we can write this a little more precisely so as not to imply supported (as in we'll fix platform-specific issues for that platform) but merely will probably work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I'll try to work something out.