Skip to content

docs: Add steps for sdk key init #193

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 4 commits into from
Apr 8, 2020

Conversation

oakbani
Copy link
Contributor

@oakbani oakbani commented Apr 6, 2020

Summary

This updates readme for factory method introduced in #189

Test plan

All checks continue to pass.

Issues

  • OASIS-6246

@oakbani oakbani removed their assignment Apr 6, 2020
@coveralls
Copy link

coveralls commented Apr 6, 2020

Coverage Status

Coverage remained the same at 98.239% when pulling 41f1dcf on oakbani/update-readme-for-init into 0be9ae0 on master.

@msohailhussain msohailhussain requested review from mjc1283 and removed request for a team April 6, 2020 21:16
Copy link
Contributor

@mikeproeng37 mikeproeng37 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Contributor

@msohailhussain msohailhussain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rest looks good to me. please fix nits.

README.md Outdated
@@ -32,7 +32,17 @@ Create the Optimizely client, for example:
$optimizely = new Optimizely(<<DATAFILE>>);
```

You can also provide an implementation of the `ProjectConfigManagerInterface` in the constructor:
Or you may also use OptimizelyFactory method to create an optimizely client using your SDK key and an optional fallback datafile. Using this method internally creates an HTTPProjectConfigManager. See HTTPProjectConfigManager for further detail.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please link HTTPProjectConfigManager to actual github file.

README.md Outdated
```
$optimizelyClient = OptimizelyFactory::createDefaultInstance("your-sdk-key", <<DATAFILE>>);
```
// access your HTTPProjectConfigManager
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's typo, should come under coding panel.

README.md Outdated
$configManager = $optimizelyClient->configManager;
```

Or you can also provide an implementation of the `ProjectConfigManagerInterface` in the constructor:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please link ProjectConfigManagerInterface to actual github file.

@mikeproeng37 mikeproeng37 merged commit 5ab0d64 into master Apr 8, 2020
@mikeproeng37 mikeproeng37 deleted the oakbani/update-readme-for-init branch April 8, 2020 18:29
jaeopt pushed a commit that referenced this pull request May 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants