Skip to content

pkg: update description to mention current features #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 15, 2025
Merged

Conversation

agilgur5
Copy link
Owner

@agilgur5 agilgur5 commented Feb 15, 2025

Summary

Add "100% test coverage, types, examples, & more." to the package.json#description

Details

  • notes all the things I've added since ~v1.0.0-ish (c.f. README updates in '22 deb3b26 and '19 05ac493)
    • this branch has been laying here for a few years now too and I think I forgot about it 😅

Verification

The NPM docs do not indicate a character limit on description, but I was concerned about that, so also tested with npm pack and no errors.

Future Work

I may remove the react-signature-pad reference eventually as this fork has now existed independently for longer than the original existed before my fork. I've been planning to "unlink" the fork it once the TS release (#42) is finally out to simplify SEO, PRs1, and reduce user confusion with all the links at the top of the repo. Will still have it mentioned in the description as historical context ofc, just no longer top-of-mind for the initial description

Footnotes

  1. By default it makes my PRs go to the original repo / react-signature-pad and requires a few clicks to redirect to main of this repo, and users occasionally click the PR button at the top of the repo too

- all the things I've added since ~v1.0.0-ish
  - this branch has been laying here for a few years now too and I think I forgot about it 😅
@agilgur5 agilgur5 added the scope: docs Documentation could be improved label Feb 15, 2025

This comment was marked as resolved.

Copy link
Owner Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

✅ LGTM

@agilgur5 agilgur5 merged commit 672c2d3 into main Feb 15, 2025
8 checks passed
@agilgur5 agilgur5 deleted the pkg-update-desc branch February 15, 2025 03:01
@agilgur5
Copy link
Owner Author

once the TS release (#42) is finally out

v1.1.0-alpha.1 has been released as the first official native TS release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: docs Documentation could be improved
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant