Skip to content

Move Core back to SDK. #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 22, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This repository is a monorepo that we manage using [Lerna](https://github.com/le

| Package | Version | Docs | Description |
| ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [`optimizely-sdk-core`](/packages/optimizely-sdk-core) | [![npm](https://img.shields.io/npm/v/optimizely-sdk-core.svg?style=flat-square)](https://npmjs.com/package/@optimizely/optimizely-sdk-core) | [![](https://img.shields.io/badge/API%20Docs-site-green.svg?style=flat-square)](https://developers.optimizely.com/x/solutions/sdks/reference/?language=javascript) | The core of Optimizely SDK |
| [`optimizely-sdk`](/packages/optimizely-sdk) | [![npm](https://img.shields.io/npm/v/optimizely-sdk.svg?style=flat-square)](https://npmjs.com/package/@optimizely/optimizely-sdk) | [![](https://img.shields.io/badge/API%20Docs-site-green.svg?style=flat-square)](https://developers.optimizely.com/x/solutions/sdks/reference/?language=javascript) | The Optimizely SDK |

## About

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
-------------------------------------------------------------------------------
2.0.0-beta
2.0.0-beta1
-------------------------------------------------------------------------------
* Consolidate JS and Node repos and packages into one.
-------------------------------------------------------------------------------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Optimizely JavaScript SDK Core
# Optimizely JavaScript SDK

This repository houses the JavaScript SDK Core for Optimizely X Full Stack.
This repository houses the JavaScript SDK for Optimizely X Full Stack.

## Getting Started

### Installing the SDK

The SDK is available through [npm](https://npmjs.com/package/optimizely-sdk-core). To install:
The SDK is available through [npm](https://npmjs.com/package/optimizely-sdk). To install:

```
npm install @optimizely/optimizely-sdk-core --save
npm install @optimizely/optimizely-sdk --save
```

Or to use in a non CommonJS fashion:
Expand All @@ -22,9 +22,7 @@ Or to use in a non CommonJS fashion:

This version represents a major version change and, as such, introduces some breaking changes:

- We have changed the package name to more accurately reflect the implementation of the SDK. Instead of using `optimizely-sdk`, we have migrated it to `optimizely-sdk-core` as this contains the core functionality of the SDK and leaves out things like datafile management. Instead the new `optimizely-sdk` package will be a wrapper around `optimizely-sdk-core` that will include more advanced functionality such as datafile management and event dispatch retries and can be used straight out of the box with minimal config. More on this later!

- The Node SDK is now combined with the JavaScript SDK so that we have one `optimizely-sdk-core` package that works across both server + browser environments.
- The Node SDK is now combined with the JavaScript SDK so that we have one `optimizely-sdk` package that works across both server + browser environments.

- We no longer support legacy Node versions (under 4.0).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@optimizely/optimizely-sdk-core",
"name": "@optimizely/optimizely-sdk",
"version": "2.0.0-beta1",
"description": "JavaScript core SDK package for Optimizely X Full Stack",
"description": "JavaScript SDK package for Optimizely X Full Stack",
"main": "dist/optimizely.node.js",
"browser": "dist/optimizely.browser.cjs.js",
"scripts": {
Expand Down