Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
qbunt committed Dec 19, 2024
1 parent d400762 commit 005a1b8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "romans",
"version": "2.0.18",
"version": "3.0.0",
"description": "A small, no-dependency lib for converting to and from roman numerals",
"main": "romans.js",
"types": "romans.d.ts",
Expand Down
4 changes: 4 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ On the fence here, but mainly to support in older codebases that are CommonJS ba
I value not having to set up typescript, and really, I do enjoy the simplicity of having a single library file. There are types and extensive JSDoc comments. Eventually, I'll cave and do multiple builds, but for now, this is fine. If you feel strongly about this decision, pull requests are open.

> What's new in v3?
Same great taste, API is 💯 identical, more tests, improved efficiency, improved types, **vastly** improved docs ⚔️

## Contributions 🤝

If you'd like to contribute to this library, please [send a PR](https://github.com/qbunt/romans/pulls) or [file a new issue](https://github.com/qbunt/romans/issues). I aim to get PRs accepted in short order *should they align with the goals*. Also, be kind, again, this started as a joke.
Expand Down

3 comments on commit 005a1b8

@github-actions
Copy link

Choose a reason for hiding this comment

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

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 100% 36/36
🟢 Branches 100% 19/19
🟢 Functions 100% 2/2
🟢 Lines 100% 33/33

Test suite run success

37 tests passing in 2 suites.

Report generated by 🧪jest coverage report action from 005a1b8

@github-actions
Copy link

Choose a reason for hiding this comment

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

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 100% 36/36
🟢 Branches 100% 19/19
🟢 Functions 100% 2/2
🟢 Lines 100% 33/33

Test suite run success

37 tests passing in 2 suites.

Report generated by 🧪jest coverage report action from 005a1b8

@github-actions
Copy link

Choose a reason for hiding this comment

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

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 100% 36/36
🟢 Branches 100% 19/19
🟢 Functions 100% 2/2
🟢 Lines 100% 33/33

Test suite run success

37 tests passing in 2 suites.

Report generated by 🧪jest coverage report action from 005a1b8

Please sign in to comment.