diff --git a/README.md b/README.md index 68d030ed7..64b80f460 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,22 @@
- This repository houses the official JavaScript SDK for use with Optimizely X Full Stack + This repository houses the official JavaScript SDK for use with Optimizely X Full Stack.
+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). That means that we actually publish [several packages](/packages) to npm from the same codebase, including: +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-sdk`](/packages/optimizely-sdk) | [](https://npmjs.com/package/@optimizely/optimizely-sdk) | [](https://developers.optimizely.com/x/solutions/sdks/reference/?language=javascript) | The Optimizely SDK | +| [`@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-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 FullStack can do for your company, please [get in touch](mailto:eng@optimizely.com)! +`@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:eng@optimizely.com)! ### Contributing diff --git a/packages/optimizely-sdk/README.md b/packages/optimizely-sdk/README.md index 3a37a0642..3b3a93641 100644 --- a/packages/optimizely-sdk/README.md +++ b/packages/optimizely-sdk/README.md @@ -1,68 +1,69 @@ -# Optimizely JavaScript SDK +# 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/) -This repository houses the JavaScript SDK for Optimizely X Full Stack. + +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 -### Installing the SDK +### Prerequisites + +Ensure the SDK supports all of the platforms you're targeting. In particular, the SDK targets any ES5-compliant JavaScript environment. We officially support: + - 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) + +Other environments likely are compatible, too, but note that we don't officially support them: + - Progressive Web Apps, WebViews, and hybrid mobile apps like those built with React Native and Apache Cordova. + - [Cloudflare Workers](https://developers.cloudflare.com/workers/) and [Fly](https://fly.io/), both of which are powered by recent releases of V8. + - Anywhere else you can think of that might embed a JavaScript engine. The sky is the limit; experiment everywhere! 🚀 -The SDK is available through [npm](https://npmjs.com/package/optimizely-sdk). To install: +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 @optimizely/optimizely-sdk --save +npm install --save @optimizely/optimizely-sdk ``` -Or to use in a non CommonJS fashion in the Browser: +### 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. -1. Run `npm run build` -2. Pull in `dist/optimizely.browser.umd.min.js` as a `