docs(README): List supported environments, add badges, and more #136
Conversation
spencerwilson-optimizely
changed the title
spencerwilson-optimizely
changed the title
.travis.yml
Outdated
| script: npm run test-xbrowser | ||
| script: | ||
| - npm test | ||
| - NODE_MAJOR=$(node -v | cut -c 2- | cut -d '.' -f 1) |
There was a problem hiding this comment.
There's an easier way to do this, I think, using the matrix config include: https://docs.travis-ci.com/user/customizing-the-build#Explicitly-Including-Jobs
|
Okay, up-to-date with |
packages/optimizely-sdk/README.md
Outdated
|
|
||
| The SDK is available through [npm](https://npmjs.com/package/optimizely-sdk). To install: | ||
| Ensure the SDK supports all of the platforms you're targeting. In particular, we support any ES5-compliant JavaScript environment, including | ||
| - 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. |
packages/optimizely-sdk/README.md
Outdated
|
|
||
| The SDK is available through [npm](https://npmjs.com/package/optimizely-sdk). To install: | ||
| Ensure the SDK supports all of the platforms you're targeting. In particular, we support any ES5-compliant JavaScript environment, including |
There was a problem hiding this comment.
I wonder if we can write this a little more precisely so as not to imply supported (as in we'll fix platform-specific issues for that platform) but merely will probably work.
There was a problem hiding this comment.
Good point, I'll try to work something out.
packages/optimizely-sdk/README.md
Outdated
|
|
||
| - We no longer support legacy Node versions (under 4.0). | ||
| - We no longer support Node.js < 4.0.0, which [reached end-of-life](https://github.com/nodejs/Release#end-of-life-releases) 2016-12-31. |
There was a problem hiding this comment.
Super nit: by 2016-12-31 would make it true for both 0.10 and 0.12. Reads kind of weird though.
There was a problem hiding this comment.
hah, yeah. Maybe
which collectively reached end-of-life 2016-12-31.
| - 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: |
There was a problem hiding this comment.
Would it be worth mentioning hybrid mobile environments like Cordova (+ Phonegap) and others like React Native?
There was a problem hiding this comment.
Ooh good call, will add
Summary
@optimizely/optimizely-sdk's READMEEventDispatchers. (I have mixed feelings on this; happy to hear opinions)Contributingsection more concisedist/artifacts, since chore(package): Delete unused build scripts #135 made them no longer a thingRendered