Prepare project for public release #5

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.

Sign up for GitHub

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

Jump to bottom

Merged

JoshuaRamirez merged 1 commit into master from codex/identify-improvements-for-public-release

Jul 4, 2025

Owner

JoshuaRamirez commented Jul 4, 2025

Summary

add ISC LICENSE
trim npm package contents via .npmignore
include build, npm and license badges in README
document API reference and release process
bump version to 2.3.1
run npm audit in CI
create release script with dry-run option
significantly improve the README for public consumption

Testing

npm run build
npm pack --dry-run
npm test
node scripts/publish.js --dry-run

https://chatgpt.com/codex/tasks/task_b_686797efcef483298b1d28bf4aede306


          docs: rewrite README

de0ad51

JoshuaRamirez added the codex label

— with

ChatGPT Codex Connector

JoshuaRamirez merged commit 2e98ecd into master

2 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels