Update README.md for SEO by willsigsworth · Pull Request #8493 · Flagsmith/flagsmith

willsigsworth · 2026-09-09T14:52:47Z

docs: update README with code sample, SDK links, and What is Flagsmith section

Thanks for submitting a PR! Please check the boxes below:

[ X] I have read the Contributing Guide.
[ X] I have added information to docs/ if required so people know about the feature.
[ X] I have filled in the "Changes" section below.
[x ] I have filled in the "How did you test this code" section below.

Changes

Contributes to

Please describe.

How did you test this code?

Previewed the changes. There is no code that affects product

Please describe.

Optimizing the readme section of the repo for search.

docs: update README with code sample, SDK links, and What is Flagsmith section

vercel · 2026-09-09T14:52:54Z

@willsigsworth is attempting to deploy a commit to the Flagsmith Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2026-09-09T14:53:13Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

📝 Walkthrough

Walkthrough

The README now describes Flagsmith’s product capabilities, deployment options, integrations, and supported application targets. It adds an interactive demo, updated quick-start instructions, JavaScript SDK usage, SDK listings, OpenFeature providers, community resources, hosted SaaS information, licensing details, and contribution links.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: 🟡 Moderate · up to 1ebca

This README refresh improves onboarding and product guidance, but the JavaScript example needs correction before merge to avoid broken integrations or accidental exposure of a server-side key. Documentation-link, provider-list, grammar, and demo-markup fixes should also be applied.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

Create stacked PR
Commit on current branch

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 2

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 38236a5b-b98f-4d68-aaf1-f856973c1df4

📥 Commits

Reviewing files that changed from the base of the PR and between c3e1dad and 62caa9b.

📒 Files selected for processing (1)

README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.

emyller

Looks great! Only a couple comments.

Co-authored-by: Matthew Elwell <mjelwell89@gmail.com>

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: ec6eec28-2320-4f3f-90e8-1ee172c7fb57

📥 Commits

Reviewing files that changed from the base of the PR and between 62caa9b and e69581d.

📒 Files selected for processing (1)

README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.

That's just how I was taught, but happy to remove Co-authored-by: Matthew Elwell <mjelwell89@gmail.com>

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)
59-59: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win

Use the current JavaScript SDK package name.

The example imports the unscoped flagsmith package. Update it to @flagsmith/flagsmith and add npm install @flagsmith/flagsmith`` before the example. Otherwise, readers can encounter a module-resolution failure.
Proposed correction
-import flagsmith from 'flagsmith';
+import flagsmith from '`@flagsmith/flagsmith`';
Add npm install @flagsmith/flagsmith`` before the example.

♻️ Duplicate comments (1)

README.md (1)

62-62: 🔒 Security & Privacy | 🛡️ Analyzed with Security Review | 🟠 Major

Sensitive Data Exposure

Reachability: External
Exploitability: Moderate
CWE: CWE-200 — Exposure of Sensitive Information to an Unauthorized Actor

Identify the key as client-side.

This browser example uses <your environment key> without stating the key type. If a reader inserts a server-side environment key, the browser exposes that secret to every user. Flagsmith documents client-side keys as public and server-side keys as secret. (docs.flagsmith.com)

Change the placeholder to <your client-side environment key> and add a warning that server-side keys must not be used in browser code.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d55b6055-18d5-4744-92b5-fc3acf82ee63

📥 Commits

Reviewing files that changed from the base of the PR and between e69581d and 9ed6efe.

📒 Files selected for processing (1)

README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.

Added the list of providers through OpenFeature

Added "As an open-source solution, Flagsmith provides flexibility and greater control over your choices. Thanks to our partnership with OpenFeature, you are never locked into one vendor."

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 53d2da06-c26a-4190-b4ec-420485d064a9

📥 Commits

Reviewing files that changed from the base of the PR and between 9ed6efe and 15351bf.

📒 Files selected for processing (1)

README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 5 remain after this review.

Added: "As this example runs in the browser, you should use your client-side environment key. Server-side keys must stay secret and never appear in browser code."

Took in coderabbit suggestions README.md#L71-L71: remove the trailing slash from the SDK overview URL. README.md#L77-L77: use https://docs.flagsmith.com/project-and-community/contributing. README.md#L91-L91: remove the trailing slash from the client-side SDK URL.

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)
38-38: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Close the demo anchor.

The block opens an <a> element at Line 36 but does not close it before </p>. Add </a> before </p> to prevent malformed HTML and inconsistent README rendering.
Proposed fix
   <a href="https://www.flagsmith.com/demo">
   <img width="75%" height="75%" src="static-files/ReadMe_Demo.gif" alt="Try our interactive demo">
+  </a>
 </p>

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d2f066d6-2334-4206-ab9e-a7016365197d

📥 Commits

Reviewing files that changed from the base of the PR and between 15351bf and 1ebcafb.

📒 Files selected for processing (1)

README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 4 remain after this review.

…tch-2

emyller

The changes look great, thank you! I've left a couple more comments. Also, for consistency, I'd like us to visit how we use the term "open-source", and standardise towards one form only: I see "Open source", "Open-Source", "open-source", etc.

- Updated opening "deployment" sentence - Fixed "open source" vs. "open-source" usage - Added link to the data model docs

emyller

This looks great, thanks @willsigsworth!

Update README.md

62caa9b

docs: update README with code sample, SDK links, and What is Flagsmith section

willsigsworth requested a review from a team as a code owner September 9, 2026 14:52

willsigsworth requested review from talissoncosta and removed request for a team September 9, 2026 14:52

coderabbitai Bot reviewed Sep 9, 2026

View reviewed changes

Comment thread README.md

Comment thread README.md Outdated

emyller requested changes Sep 9, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md

matthewelwell reviewed Sep 9, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md Outdated

Apply suggestion from @matthewelwell

e69581d

Co-authored-by: Matthew Elwell <mjelwell89@gmail.com>

coderabbitai Bot reviewed Sep 10, 2026

View reviewed changes

Comment thread README.md

Apply suggestion from @matthewelwell

9ed6efe

That's just how I was taught, but happy to remove Co-authored-by: Matthew Elwell <mjelwell89@gmail.com>

coderabbitai Bot reviewed Sep 10, 2026

View reviewed changes

willsigsworth added 2 commits September 10, 2026 08:18

Update README.md

15351bf

Added the list of providers through OpenFeature

Update README.md

1ebcafb

Added "As an open-source solution, Flagsmith provides flexibility and greater control over your choices. Thanks to our partnership with OpenFeature, you are never locked into one vendor."

coderabbitai Bot reviewed Sep 10, 2026

View reviewed changes

Comment thread README.md

willsigsworth added 2 commits September 10, 2026 08:23

Update README.md

07e64ad

Added: "As this example runs in the browser, you should use your client-side environment key. Server-side keys must stay secret and never appear in browser code."

Update README.md

e64eb69

Took in coderabbit suggestions README.md#L71-L71: remove the trailing slash from the SDK overview URL. README.md#L77-L77: use https://docs.flagsmith.com/project-and-community/contributing. README.md#L91-L91: remove the trailing slash from the client-side SDK URL.

coderabbitai Bot reviewed Sep 10, 2026

View reviewed changes

willsigsworth commented Sep 10, 2026

View reviewed changes

Comment thread README.md

Merge branch 'main' of https://github.com/Flagsmith/flagsmith into pa…

470af5a

…tch-2

emyller requested changes Sep 21, 2026

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md

Comment thread README.md

Update README.md

983cbaa

- Updated opening "deployment" sentence - Fixed "open source" vs. "open-source" usage - Added link to the data model docs

willsigsworth commented Sep 22, 2026

View reviewed changes

Comment thread README.md

emyller approved these changes Sep 22, 2026

View reviewed changes

Conversation

willsigsworth commented Sep 9, 2026

Changes

How did you test this code?

Uh oh!

vercel Bot commented Sep 9, 2026

Uh oh!

coderabbitai Bot commented Sep 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

emyller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

emyller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emyller left a comment

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai Bot commented Sep 9, 2026 •

edited

Loading