Skip to content
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

README and CHANGELOG on dev branch are out-of-sync with content #47

Closed
sogaiu opened this issue Feb 28, 2023 · 7 comments
Closed

README and CHANGELOG on dev branch are out-of-sync with content #47

sogaiu opened this issue Feb 28, 2023 · 7 comments

Comments

@sogaiu
Copy link
Owner

sogaiu commented Feb 28, 2023

I've made this issue as a follow-on to this comment.

I've made a draft replacement README, a supplementary document and done some rearrangement so I'll push those changes to the dev branch.

@sogaiu
Copy link
Owner Author

sogaiu commented Feb 28, 2023

7577e43 contains the initial work on said changes.

@sogaiu
Copy link
Owner Author

sogaiu commented Mar 2, 2023

Updated in 701c948 and 7307282 with some additional info in the what and why doc.

@sogaiu sogaiu changed the title README on dev branch is out-of-sync with content README and CHANGELOG on dev branch are out-of-sync with content Mar 2, 2023
@sogaiu
Copy link
Owner Author

sogaiu commented Mar 2, 2023

Updated the CHANGELOG file in 7b81d78 -- this is still a draft.

@sogaiu
Copy link
Owner Author

sogaiu commented Mar 4, 2023

Added some details about building Node.js bindings to the what and why doc in ef1667f. Also adjusted package.json further in light of the docs.

@sogaiu
Copy link
Owner Author

sogaiu commented Mar 4, 2023

Added more info in 8288854 about bindings (including a link to official docs) as well as a bit about Rust bindings.

Also improved the Node.js bindings section with a more robust method.

@sogaiu
Copy link
Owner Author

sogaiu commented Mar 12, 2023

As we are splitting off some of the dev-related bits into another repository and some of those bits were on the dev branch, I've made a separate pre-0.0.12 branch to preserve the bits that are remaining here.

Latest versions of some things on the pre-0.0.12 branch are:

@sogaiu
Copy link
Owner Author

sogaiu commented May 8, 2023

v0.0.12 included changes that addressed this issue.

@sogaiu sogaiu closed this as completed May 8, 2023
@sogaiu sogaiu removed the candidate-on-dev The dev branch contains code to address label May 8, 2023
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

No branches or pull requests

1 participant