Skip to content
This repository has been archived by the owner on Jun 15, 2021. It is now read-only.

Expanded the Options section, added caveat in Production-Ready section #484

Merged
merged 1 commit into from
Jun 14, 2016
Merged

Expanded the Options section, added caveat in Production-Ready section #484

merged 1 commit into from
Jun 14, 2016

Conversation

danburzo
Copy link
Contributor

I propose two changes to README.md:

  1. Better documentation of user-configurable options, which are not apparent (as far as I could tell) unless reading through the source code.
  2. A caveat in the production-ready section, since it was a bit surprising that after a (long-due) update in our Scribe instance, it stopped working in Safari 8 and Chrome 45 (due to missing support for Object.assign -- which BTW is easily patched with a polyfill, something worth considering?)

@rrees rrees self-assigned this Jun 13, 2016
@rrees
Copy link
Contributor

rrees commented Jun 13, 2016

I can see why you want the expanded documentation but I might add them into the wiki or a docs folder rather than README since they are not things you need to access frequently. I will also add a version note to things like the default plugin list which will change in future. Hope that's okay with you.

Version 3 of Scribe was a deliberately breaking change (hence a major version number) but you're right that it would be sensible to add some notes about what people might need to polyfill for older browsers.

Thanks for contributing!

@danburzo
Copy link
Contributor Author

Sounds good! 👍

@rrees rrees merged commit 62cf8a9 into guardian:master Jun 14, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants