Skip to content

Commit 0e76d01

Browse files
author
Michael Ng
authored
chore: Update changelog and readme with latest changes. (#137)
1 parent e618942 commit 0e76d01

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

CHANGELOG.MD

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
66

77
## [Unreleased]
88
Changes that have landed but are not yet released. Changes that have landed but are not yet released.
9-
- None
9+
10+
### Breaking Changes
11+
- Refactored EventProcessor and ConfigManager components to no longer require an ExecutionContext be passed in during construction. It will be injected into them by the client factory. [#130](https://github.com/optimizely/go-sdk/pull/130)
12+
- Moved the entire `optimizely` package from `github.com/optimizely/go-sdk/optimizely` to `github.com/optimizely/go-sdk/pkg` to better follow convention and best practices. [#135](https://github.com/optimizely/go-sdk/pull/135)
1013

1114
## [1.0.0-beta2] - October 2nd, 2019
1215

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
To start using the SDK, create an instance using our factory method:
1010

1111
```
12-
import "github.com/optimizely/go-sdk/optimizely/client"
12+
import "github.com/optimizely/go-sdk/pkg/client"
1313
1414
optimizelyFactory := &client.OptimizelyFactory{
1515
SDKKey: "[SDK_KEY_HERE]",
@@ -29,8 +29,8 @@ client, err := optimizelyFactory.Client()
2929
### Feature Rollouts
3030
```
3131
import (
32-
"github.com/optimizely/go-sdk/optimizely/client"
33-
"github.com/optimizely/go-sdk/optimizely/entities"
32+
"github.com/optimizely/go-sdk/pkg/client"
33+
"github.com/optimizely/go-sdk/pkg/entities"
3434
)
3535
3636
user := entities.UserContext{
@@ -95,14 +95,14 @@ module mymodule
9595
go 1.12
9696
9797
require (
98-
github.com/optimizely/go-sdk v0.2.0
98+
github.com/optimizely/go-sdk v1.0.0-beta2
9999
)
100100
```
101101

102102
If you are already using `go.mod` in your application you can run the following:
103103

104104
```
105-
go mod edit -require github.com/optimizely/go-sdk@v0.2.0
105+
go mod edit -require github.com/optimizely/go-sdk@v1.0.0-beta2
106106
```
107107

108108
NOTE:
@@ -111,7 +111,7 @@ go get github.com/optimizely/go-sdk/...
111111
```
112112
or
113113
```$sh
114-
go get github.com/optimizely/go-sdk/optimizely
114+
go get github.com/optimizely/go-sdk/pkg
115115
```
116116
will install it as a package to pkg directory, rather than src directory. It could be useful for future development and vendoring.
117117

0 commit comments

Comments
 (0)