@gooddadmike/ifc-js 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ifc-js
|
|
1
|
+
# @gooddadmike/ifc-js
|
|
2
2
|
|
|
3
3
|
A lightweight JavaScript library for converting dates between the Gregorian
|
|
4
4
|
calendar and the International Fixed Calendar (IFC).
|
|
@@ -26,9 +26,9 @@ The remaining day (or two in a leap year) becomes something more interesting
|
|
|
26
26
|
than just another Tuesday. These intercalary days sit at the end of their
|
|
27
27
|
month like a 29th day but belong to no week and no weekday.
|
|
28
28
|
|
|
29
|
-
- 🎆 **Year Day** (Dec 29)
|
|
30
|
-
New
|
|
31
|
-
- ☀️ **Leap Day** (Jun 29)
|
|
29
|
+
- 🎆 **Year Day** (Dec 29) after the last day of December every year.
|
|
30
|
+
New Years Eve elevated: a day outside the week, a pause between years.
|
|
31
|
+
- ☀️ **Leap Day** (Jun 29) after June 28 in leap years only. In any
|
|
32
32
|
normal IFC month, day 28 is a Saturday. Instead of a lost Sunday, this
|
|
33
33
|
becomes a once every four years midsummer holiday outside the week entirely.
|
|
34
34
|
|
|
@@ -36,12 +36,12 @@ month like a 29th day but belong to no week and no weekday.
|
|
|
36
36
|
|
|
37
37
|
## Install
|
|
38
38
|
```bash
|
|
39
|
-
npm install ifc-js
|
|
39
|
+
npm install @gooddadmike/ifc-js
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
For the CLI:
|
|
43
43
|
```bash
|
|
44
|
-
npm install -g ifc-js
|
|
44
|
+
npm install -g @gooddadmike/ifc-js
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
---
|
|
@@ -73,7 +73,7 @@ IFC:2024-06-29
|
|
|
73
73
|
|
|
74
74
|
Converts a Gregorian date to an IFC result object.
|
|
75
75
|
```js
|
|
76
|
-
const { toIFC } = require('ifc-js');
|
|
76
|
+
const { toIFC } = require('@gooddadmike/ifc-js');
|
|
77
77
|
|
|
78
78
|
toIFC('2026-03-22');
|
|
79
79
|
// {
|
|
@@ -104,7 +104,7 @@ Months are 1-based: 1=January, 7=Sol, 13=December.
|
|
|
104
104
|
|
|
105
105
|
Converts an IFC date string to a Gregorian ISO date string.
|
|
106
106
|
```js
|
|
107
|
-
const { toGregorian } = require('ifc-js');
|
|
107
|
+
const { toGregorian } = require('@gooddadmike/ifc-js');
|
|
108
108
|
|
|
109
109
|
toGregorian('IFC:2024-06-29'); // '2024-06-17' (Leap Day)
|
|
110
110
|
toGregorian('IFC:2026-07-01'); // '2026-06-18' (Sol 1)
|
|
@@ -117,7 +117,7 @@ toGregorian('IFC:2026-13-29'); // '2026-12-31' (Year Day)
|
|
|
117
117
|
|
|
118
118
|
Returns `true` if the given year is a leap year.
|
|
119
119
|
```js
|
|
120
|
-
const { isLeap } = require('ifc-js');
|
|
120
|
+
const { isLeap } = require('@gooddadmike/ifc-js');
|
|
121
121
|
|
|
122
122
|
isLeap(2024); // true
|
|
123
123
|
isLeap(2026); // false
|
|
@@ -129,7 +129,7 @@ isLeap(2000); // true
|
|
|
129
129
|
|
|
130
130
|
### ES Modules
|
|
131
131
|
```js
|
|
132
|
-
import { toIFC, toGregorian, isLeap } from 'ifc-js';
|
|
132
|
+
import { toIFC, toGregorian, isLeap } from '@gooddadmike/ifc-js';
|
|
133
133
|
```
|
|
134
134
|
|
|
135
135
|
---
|
|
@@ -163,3 +163,4 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
163
163
|
## License
|
|
164
164
|
|
|
165
165
|
MIT
|
|
166
|
+
|