Skip to content

chore: change README to minimal contributor-focused version#851

Merged
dharmadeveloper108 merged 1 commit into
mainfrom
update-readme
Apr 9, 2026
Merged

chore: change README to minimal contributor-focused version#851
dharmadeveloper108 merged 1 commit into
mainfrom
update-readme

Conversation

@dharmadeveloper108
Copy link
Copy Markdown
Contributor

@dharmadeveloper108 dharmadeveloper108 commented Apr 8, 2026 •
edited
Loading

  • Replaces the full usage documentation in README with a minimal version following the same pattern as the Go SDK README
  • Removes some of the documentation that now (when the PR is merged) lives in the docs site
  • Makes README focus on: quick start, requirements, and contributing (local dev, tests, benchmarking, linting, building)
  • Removes stale Code Climate badge

dharmadeveloper108
dharmadeveloper108 commented Apr 8, 2026
View reviewed changes
Comment thread README.md
[![Unleash node SDK on npm](https://img.shields.io/npm/v/unleash-client)](https://www.npmjs.com/package/unleash-client)
![npm downloads](https://img.shields.io/npm/dm/unleash-client)
[![Build Status](https://github.com/Unleash/unleash-node-sdk/actions/workflows/build-and-test.yaml/badge.svg)](https://github.com/Unleash/unleash-node-sdk/actions)
[![Code Climate](https://codeclimate.com/github/Unleash/unleash-node-sdk/badges/gpa.svg)](https://codeclimate.com/github/Unleash/unleash-node-sdk)
Copy link
Copy Markdown
Contributor Author

@dharmadeveloper108 dharmadeveloper108 Apr 8, 2026

Choose a reason for hiding this comment

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

Doesn't look like we use this anymore right?

Copy link
Copy Markdown
Contributor

@melindafekete melindafekete Apr 8, 2026

Choose a reason for hiding this comment

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

I'm not sure, but I got a redirect to https://qlty.sh/ 🤔 I think it's ok to remove

@dharmadeveloper108 dharmadeveloper108 marked this pull request as ready for review April 8, 2026 15:31
@coveralls
Copy link
Copy Markdown

coveralls commented Apr 8, 2026

Coverage Report for CI Build 24143754774

Coverage remained the same at 90.213%

Details

  • Coverage remained the same as the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.

Coverage Stats

Coverage Status
Relevant Lines: 1327
Covered Lines: 1241
Line Coverage: 93.52%
Relevant Branches: 788
Covered Branches: 667
Branch Coverage: 84.64%
Branches in Coverage %: Yes
Coverage Strength: 5084.81 hits per line
💛 - Coveralls

melindafekete
melindafekete approved these changes Apr 8, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@melindafekete melindafekete left a comment

Choose a reason for hiding this comment

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

this looks awesome. thank you @dharmadeveloper108

@github-project-automation github-project-automation Bot moved this from New to Approved PRs in Issues and PRs Apr 8, 2026
@dharmadeveloper108 dharmadeveloper108 merged commit 69a2c96 into main Apr 9, 2026
6 checks passed
@dharmadeveloper108 dharmadeveloper108 deleted the update-readme branch April 9, 2026 08:58
@github-project-automation github-project-automation Bot moved this from Approved PRs to Done in Issues and PRs Apr 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@melindafekete melindafekete melindafekete approved these changes

Assignees

No one assigned

Labels

None yet

Projects

Issues and PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dharmadeveloper108 @coveralls @melindafekete @thomasheartman