Skip to content

docs: add npm badges and update flagd-core version references#26

Merged
jonathannorris merged 1 commit intomainfrom
docs/update-readmes
Apr 1, 2026
Merged

docs: add npm badges and update flagd-core version references#26
jonathannorris merged 1 commit intomainfrom
docs/update-readmes

Conversation

@jonathannorris
Copy link
Copy Markdown
Member

Summary

  • Adds npm version, license, and CI badges to the package README
  • Updates flagd-core version references from @1.3.0+ to @^2.0.0 in both READMEs
  • Adds npm package link to the root README's repository guide

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation by adding npm package links and status badges, and bumps the referenced version of @openfeature/flagd-core to ^2.0.0. A review comment suggests clarifying the compatibility section in the README to avoid implying that versions prior to 2.0.0 lack Cloudflare Workers support, as this feature was originally introduced in version 1.3.0.

Comment thread README.md
## Workers Compatibility

`@openfeature/flagd-core@1.3.0` and later support Cloudflare Workers and other V8 isolate runtimes without relying on dynamic code generation. This repo consumes the released package directly and uses `disableDynamicCodeGeneration: true` so targeting rules stay compatible with Workers runtime restrictions. The upstream work landed through [open-feature/js-sdk-contrib#1480](https://github.com/open-feature/js-sdk-contrib/issues/1480).
`@openfeature/flagd-core@^2.0.0` supports Cloudflare Workers and other V8 isolate runtimes without relying on dynamic code generation. This repo consumes the released package directly and uses `disableDynamicCodeGeneration: true` so targeting rules stay compatible with Workers runtime restrictions. The upstream work landed through [open-feature/js-sdk-contrib#1480](https://github.com/open-feature/js-sdk-contrib/issues/1480).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The update to @openfeature/flagd-core@^2.0.0 in this section might be misleading. The original text correctly identified that support for Cloudflare Workers began with version 1.3.0. By changing it to ^2.0.0, it implies that earlier versions (like 1.3.0 to 1.x) do not support it, which is not the case. It's better to maintain the historical compatibility information while noting the version currently used by this repository.

Suggested change
`@openfeature/flagd-core@^2.0.0` supports Cloudflare Workers and other V8 isolate runtimes without relying on dynamic code generation. This repo consumes the released package directly and uses `disableDynamicCodeGeneration: true` so targeting rules stay compatible with Workers runtime restrictions. The upstream work landed through [open-feature/js-sdk-contrib#1480](https://github.com/open-feature/js-sdk-contrib/issues/1480).
`@openfeature/flagd-core@1.3.0` and later (this repository uses `^2.0.0`) support Cloudflare Workers and other V8 isolate runtimes without relying on dynamic code generation. This repo consumes the released package directly and uses `disableDynamicCodeGeneration: true` so targeting rules stay compatible with Workers runtime restrictions. The upstream work landed through [open-feature/js-sdk-contrib#1480](https://github.com/open-feature/js-sdk-contrib/issues/1480).

@jonathannorris jonathannorris merged commit dc6d70b into main Apr 1, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant