Skip to content

Commit 97b4aa2

Browse files
docs(README): Add credits and additional code (#149)
Marcelo's asked us to add "Credits" and "Additional Code" sections, where: > "Credits" is for dependencies that Optimizely distributes (i.e. any code that they download from us, for example, from a repo we set up). If there is a dependency that the customer separately installs / pulls from some non-Optimizely source, then that goes into the "Additional Code" section. The Python SDK, for example, has a few runtime dependencies like `pip` that the customer needs to install when setting up their application environment, but these are not distributed by Optimizely. I take this to mean Credits is the code checked into this repo (including vendored deps, of which javascript-sdk has none), and "Additional Code" is any other code that is required for prod usage.
1 parent 6a3c9a5 commit 97b4aa2

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

packages/optimizely-sdk/README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,49 @@ npm run test-xbrowser
6767

6868
[.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).
6969

70+
## Credits
71+
72+
First-party code (under lib/) is copyright Optimizely, Inc. and contributors, licensed under Apache 2.0.
73+
74+
## Additional Code
75+
76+
Prod dependencies are as follows:
77+
78+
```json
79+
{
80+
"json-schema@0.2.3": {
81+
"licenses": [
82+
"AFLv2.1",
83+
"BSD"
84+
],
85+
"publisher": "Kris Zyp",
86+
"repository": "https://github.com/kriszyp/json-schema"
87+
},
88+
"lodash@4.17.10": {
89+
"licenses": "MIT",
90+
"publisher": "John-David Dalton",
91+
"repository": "https://github.com/lodash/lodash"
92+
},
93+
"murmurhash@0.0.2": {
94+
"licenses": "MIT*",
95+
"repository": "https://github.com/perezd/node-murmurhash"
96+
},
97+
"sprintf@0.1.5": {
98+
"licenses": "BSD-3-Clause",
99+
"publisher": "Moritz Peters",
100+
"repository": "https://github.com/maritz/node-sprintf"
101+
},
102+
"uuid@3.2.1": {
103+
"licenses": "MIT",
104+
"repository": "https://github.com/kelektiv/node-uuid"
105+
}
106+
}
107+
```
108+
109+
To regenerate this, run the following command:
110+
111+
```sh
112+
npx license-checker --production --json | jq 'map_values({ licenses, publisher, repository }) | del(.[][] | nulls)'
113+
```
114+
115+
and remove the self (`@optimizely/optimizely-sdk`) entry.

0 commit comments

Comments
 (0)