datevolt 1.0.3 → 1.0.4

package/README.md

@@ -4,26 +4,30 @@
 [![npm downloads](https://img.shields.io/npm/dm/datevolt.svg?style=flat-square)](https://www.npmjs.com/package/datevolt)
 [![license](https://img.shields.io/npm/l/datevolt.svg?style=flat-square)](LICENSE)
 [![zero dependencies](https://img.shields.io/badge/dependencies-0-brightgreen?style=flat-square)](package.json)
+[![React Native](https://img.shields.io/badge/React%20Native-compatible-blue?style=flat-square)](https://reactnative.dev)
 
-A lightweight, zero-dependency JavaScript date library that works just like moment.js — but without the bloat. Built specifically with React Native CLI in mind (Android + iOS, Hermes & JSC), though it works perfectly fine in Node.js and browsers too.
-
-I built this because moment.js is massive (~72 KB gzipped) and causes issues in some React Native setups. datevolt gives you the same familiar API at a fraction of the size.
+A complete, lightweight, zero-dependency JavaScript date library with a familiar chainable API. Built with React Native CLI in mind (Android + iOS, Hermes & JSC), and works just as well in Node.js and browsers.
 
 ---
 
 ## Why datevolt?
 
-| | moment.js | datevolt |
-|---|---|---|
-| Size (gzipped) | ~72 KB | ~8 KB |
-| Size (minified) | ~290 KB | ~25 KB |
-| Dependencies | 0 | 0 |
-| Tree-shakeable | ❌ | ✅ |
-| Immutable `.clone()` | ❌ | ✅ |
-| React Native safe | ⚠️ | ✅ |
-| moment.js API | ✅ | ✅ |
+Most date libraries are either too heavy for mobile apps or too minimal to be useful. datevolt hits the middle ground — full-featured, tiny footprint, no dependencies, and no native modules.
+
+| Feature | datevolt |
+|---|---|
+| Size (gzipped) | ~8 KB |
+| Size (minified) | ~25 KB |
+| Dependencies | 0 |
+| Tree-shakeable | ✅ |
+| Immutable `.clone()` | ✅ |
+| React Native (Hermes + JSC) | ✅ |
+| Node.js | ✅ |
+| Browser | ✅ |
+| Chainable API | ✅ |
+| Built-in i18n | ✅ |
 
-No `Intl` dependency, no native modules, no config needed — just install and use.
+No `Intl` dependency. No native modules. No configuration. Just install and use.
 
 ---
 
@@ -46,19 +50,19 @@ const datevolt = require('datevolt');
 // or
 import datevolt from 'datevolt';
 
-datevolt().format('YYYY-MM-DD HH:mm:ss')          // "2024-06-15 14:30:00"
-datevolt('2024-06-15').format('dddd, MMMM D, YYYY') // "Saturday, June 15, 2024"
-datevolt().add(7, 'days').format('DD MMM YYYY')    // "22 Jun 2024"
-datevolt('2024-01-01').fromNow()                   // "6 months ago"
-datevolt('2024-06-15').diff('2024-01-01', 'days')  // 166
-datevolt('2024-06-15').isBefore('2024-12-31')      // true
+datevolt().format('YYYY-MM-DD HH:mm:ss')             // "2024-06-15 14:30:00"
+datevolt('2024-06-15').format('dddd, MMMM D, YYYY')  // "Saturday, June 15, 2024"
+datevolt().add(7, 'days').format('DD MMM YYYY')       // "22 Jun 2024"
+datevolt('2024-01-01').fromNow()                      // "6 months ago"
+datevolt('2024-06-15').diff('2024-01-01', 'days')     // 166
+datevolt('2024-06-15').isBefore('2024-12-31')         // true
 ```
 
 ---
 
 ## React Native
 
-No special setup needed. Works with both Hermes and JSC engines.
+Works out of the box — no extra setup, no metro config changes needed.
 
 ```js
 import datevolt from 'datevolt';
@@ -69,6 +73,8 @@ const DateDisplay = () => {
 };
 ```
 
+Tested on Android (Hermes) and iOS (JSC). Pure JavaScript — no native bridge needed.
+
 ---
 
 ## API Reference
@@ -76,23 +82,23 @@ const DateDisplay = () => {
 ### Parsing
 
 ```js
-datevolt()                                           // now
-datevolt('2024-06-15')                               // ISO date (local midnight)
-datevolt('2024-06-15T10:30:00')                      // ISO datetime
-datevolt('2024-06-15T10:30:00Z')                     // UTC
-datevolt('2024-06-15T10:30:00+05:30')                // with offset
-datevolt('15/06/2024', 'DD/MM/YYYY')                 // custom format
-datevolt('15/06/2024', ['DD/MM/YYYY', 'YYYY-MM-DD']) // multiple formats
-datevolt([2024, 5, 15])                              // array [Y, M(0-based), D]
-datevolt([2024, 5, 15, 14, 30, 0, 0])               // array with time
-datevolt({ year: 2024, month: 5, day: 15 })          // object
-datevolt(1718438400000)                              // unix milliseconds
-datevolt.unix(1718438400)                            // unix seconds
-datevolt.utc('2024-06-15T10:30:00')                  // UTC mode
+datevolt()                                            // now
+datevolt('2024-06-15')                                // ISO date (local midnight)
+datevolt('2024-06-15T10:30:00')                       // ISO datetime
+datevolt('2024-06-15T10:30:00Z')                      // UTC
+datevolt('2024-06-15T10:30:00+05:30')                 // with offset
+datevolt('15/06/2024', 'DD/MM/YYYY')                  // custom format
+datevolt('15/06/2024', ['DD/MM/YYYY', 'YYYY-MM-DD'])  // multiple formats
+datevolt([2024, 5, 15])                               // array [Y, M(0-based), D]
+datevolt([2024, 5, 15, 14, 30, 0, 0])                // array with time
+datevolt({ year: 2024, month: 5, day: 15 })           // object
+datevolt(1718438400000)                               // unix milliseconds
+datevolt.unix(1718438400)                             // unix seconds
+datevolt.utc('2024-06-15T10:30:00')                   // UTC mode
 
 // Validation
-datevolt('2024-06-15').isValid()   // true
-datevolt('not-a-date').isValid()   // false
+datevolt('2024-06-15').isValid()    // true
+datevolt('not-a-date').isValid()    // false
 ```
 
 ---
@@ -102,13 +108,13 @@ datevolt('not-a-date').isValid()   // false
 ```js
 const d = datevolt('2024-06-15T14:30:45.123');
 
-d.year()         // 2024      →  d.year(2025)
-d.month()        // 5         →  d.month(0)      (0-based)
-d.date()         // 15        →  d.date(1)
-d.day()          // 6         →  d.day(1)        (0=Sun, 6=Sat)
-d.hour()         // 14        →  d.hour(9)
-d.minute()       // 30        →  d.minute(0)
-d.second()       // 45        →  d.second(0)
+d.year()         // 2024   →  d.year(2025)
+d.month()        // 5      →  d.month(0)     (0-based, Jan = 0)
+d.date()         // 15     →  d.date(1)
+d.day()          // 6      →  d.day(1)       (0 = Sun, 6 = Sat)
+d.hour()         // 14     →  d.hour(9)
+d.minute()       // 30     →  d.minute(0)
+d.second()       // 45     →  d.second(0)
 d.millisecond()  // 123
 
 d.quarter()      // 2
@@ -116,10 +122,10 @@ d.dayOfYear()    // 167
 d.daysInMonth()  // 30
 d.week()         // ISO week number
 d.isoWeek()
-d.isoWeekday()   // 1=Mon ... 7=Sun
+d.isoWeekday()   // 1 = Mon ... 7 = Sun
 d.weeksInYear()
 
-// Generic get/set
+// Generic
 d.get('year')        // 2024
 d.set('year', 2025)  // chainable
 ```
@@ -139,10 +145,10 @@ datevolt().add({ days: 1, hours: 2, minutes: 30 })  // object form
 datevolt().subtract(1, 'week')
 datevolt().subtract(3, 'months')
 
-// Chain as much as you want
+// Chainable
 datevolt('2024-01-01').add(1, 'year').subtract(3, 'months').startOf('month')
 
-// startOf
+// startOf / endOf
 datevolt().startOf('year')     // Jan 1, 00:00:00.000
 datevolt().startOf('month')    // 1st of month, 00:00:00.000
 datevolt().startOf('week')
@@ -151,9 +157,8 @@ datevolt().startOf('hour')
 datevolt().startOf('quarter')
 datevolt().startOf('isoWeek')
 
-// endOf
 datevolt().endOf('year')       // Dec 31, 23:59:59.999
-datevolt().endOf('month')      // last day of month
+datevolt().endOf('month')      // last day, 23:59:59.999
 
 datevolt().clone()             // immutable copy
 ```
@@ -175,7 +180,7 @@ datevolt().format('LLL')                     // "June 15, 2024 2:30 PM"
 datevolt().format('LLLL')                    // "Saturday, June 15, 2024 2:30 PM"
 ```
 
-**Tokens:**
+**Format Tokens**
 
 | Token | Output | Description |
 |-------|--------|-------------|
@@ -206,13 +211,13 @@ datevolt().format('LLLL')                    // "Saturday, June 15, 2024 2:30 PM
 ### Relative Time
 
 ```js
-datevolt('2024-01-01').fromNow()              // "6 months ago"
-datevolt().add(2, 'hours').fromNow()          // "in 2 hours"
-datevolt().subtract(3, 'days').fromNow(true)  // "3 days" (no suffix)
+datevolt('2024-01-01').fromNow()               // "6 months ago"
+datevolt().add(2, 'hours').fromNow()           // "in 2 hours"
+datevolt().subtract(3, 'days').fromNow(true)   // "3 days" (no suffix)
 
-datevolt('2024-01-01').from('2024-06-15')     // "6 months ago"
-datevolt().add(5, 'minutes').toNow()          // "in 5 minutes"
-datevolt('2024-01-01').to('2024-06-15')       // "in 6 months"
+datevolt('2024-01-01').from('2024-06-15')      // "6 months ago"
+datevolt().add(5, 'minutes').toNow()           // "in 5 minutes"
+datevolt('2024-01-01').to('2024-06-15')        // "in 6 months"
 ```
 
 ---
@@ -220,11 +225,11 @@ datevolt('2024-01-01').to('2024-06-15')       // "in 6 months"
 ### Calendar
 
 ```js
-datevolt().calendar()                    // "Today at 2:30 PM"
-datevolt().add(1, 'day').calendar()      // "Tomorrow at 2:30 PM"
-datevolt().subtract(1, 'day').calendar() // "Yesterday at 2:30 PM"
-datevolt().add(3, 'days').calendar()     // "Tuesday at 2:30 PM"
-datevolt().subtract(7, 'days').calendar()// "06/08/2024"
+datevolt().calendar()                     // "Today at 2:30 PM"
+datevolt().add(1, 'day').calendar()       // "Tomorrow at 2:30 PM"
+datevolt().subtract(1, 'day').calendar()  // "Yesterday at 2:30 PM"
+datevolt().add(3, 'days').calendar()      // "Tuesday at 2:30 PM"
+datevolt().subtract(7, 'days').calendar() // "06/08/2024"
 ```
 
 ---
@@ -232,11 +237,11 @@ datevolt().subtract(7, 'days').calendar()// "06/08/2024"
 ### Diff
 
 ```js
-datevolt('2024-06-15').diff('2024-01-01', 'days')        // 166
-datevolt('2024-06-15').diff('2024-01-01', 'months')      // 5
-datevolt('2024-06-15').diff('2020-01-01', 'years')       // 4
+datevolt('2024-06-15').diff('2024-01-01', 'days')              // 166
+datevolt('2024-06-15').diff('2024-01-01', 'months')            // 5
+datevolt('2024-06-15').diff('2020-01-01', 'years')             // 4
 datevolt('2024-06-15T12:00').diff('2024-06-15T10:00', 'hours') // 2
-datevolt('2024-06-15').diff('2024-01-01', 'days', true)  // 166.xxx (float)
+datevolt('2024-06-15').diff('2024-01-01', 'days', true)        // 166.xxx (float)
 ```
 
 ---
@@ -244,12 +249,12 @@ datevolt('2024-06-15').diff('2024-01-01', 'days', true)  // 166.xxx (float)
 ### Query & Comparison
 
 ```js
-datevolt('2024-01-01').isBefore('2024-06-15')                        // true
-datevolt('2024-06-15').isAfter('2024-01-01')                         // true
-datevolt('2024-06-15T10:00').isSame('2024-06-15T18:00', 'day')       // true
-datevolt('2024-01-01').isSameOrBefore('2024-01-01')                  // true
-datevolt('2024-06-15').isSameOrAfter('2024-06-15')                   // true
-datevolt('2024-03-15').isBetween('2024-01-01', '2024-12-31')         // true
+datevolt('2024-01-01').isBefore('2024-06-15')                         // true
+datevolt('2024-06-15').isAfter('2024-01-01')                          // true
+datevolt('2024-06-15T10:00').isSame('2024-06-15T18:00', 'day')        // true
+datevolt('2024-01-01').isSameOrBefore('2024-01-01')                   // true
+datevolt('2024-06-15').isSameOrAfter('2024-06-15')                    // true
+datevolt('2024-03-15').isBetween('2024-01-01', '2024-12-31')          // true
 datevolt('2024-01-01').isBetween('2024-01-01', '2024-12-31', null, '[]') // inclusive
 
 datevolt('2024-06-15').isLeapYear()  // true
@@ -265,14 +270,14 @@ datevolt.isDate(new Date())          // true
 ```js
 // UTC mode
 datevolt.utc('2024-06-15T10:30:00').format('HH:mm')  // always UTC hours
-datevolt.utc().isUTC()   // true
-datevolt.utc().local()   // switch back to local
+datevolt.utc().isUTC()    // true
+datevolt.utc().local()    // switch back to local
 
 // UTC offset
-datevolt().utcOffset()           // offset in minutes
-datevolt().utcOffset('+05:30')   // set by string
-datevolt().utcOffset(330)        // set by minutes
-datevolt().utcOffset(0, true)    // keep local time, change offset
+datevolt().utcOffset()            // offset in minutes
+datevolt().utcOffset('+05:30')    // set by string
+datevolt().utcOffset(330)         // set by minutes
+datevolt().utcOffset(0, true)     // keep local time, change offset
 ```
 
 ---
@@ -286,7 +291,7 @@ d.asHours()    // 48
 d.asMinutes()  // 2880
 
 datevolt.duration({ hours: 1, minutes: 30 }).asMinutes()  // 90
-datevolt.duration('P1Y2M3DT4H5M6S')                       // ISO 8601 string
+datevolt.duration('P1Y2M3DT4H5M6S')                       // ISO 8601 duration
 
 datevolt.duration(1, 'day').humanize()       // "a day"
 datevolt.duration(1, 'day').humanize(true)   // "in a day"
@@ -296,7 +301,7 @@ d.add(1, 'hour').subtract(30, 'minutes')
 d.clone()
 d.toISOString()  // "P2D"
 
-// Use duration directly in add()
+// Pass duration directly into add()
 datevolt().add(datevolt.duration(2, 'hours'))
 
 datevolt.isDuration(d)  // true
@@ -309,24 +314,24 @@ datevolt.isDuration(d)  // true
 7 built-in locales: `en`, `hi`, `es`, `fr`, `de`, `ar`, `ja`
 
 ```js
-// Global locale
+// Set global locale
 datevolt.locale('hi');
 datevolt().format('MMMM D, YYYY');  // "जून 15, 2024"
 
-// Per-instance
+// Per-instance locale
 datevolt().locale('es').format('MMMM');  // "junio"
 
-// List available
+// List all available
 datevolt.locales();  // ['en', 'hi', 'es', 'fr', 'de', 'ar', 'ja']
 
-// Custom locale
+// Define a custom locale
 datevolt.defineLocale('mr', {
   name: 'mr',
   months: ['जानेवारी', 'फेब्रुवारी', 'मार्च', ...],
   // ...
 });
 
-// Locale data
+// Access locale data
 datevolt.localeData('en').months
 datevolt().localeData()
 ```
@@ -336,28 +341,24 @@ datevolt().localeData()
 ### Static Methods
 
 ```js
-datevolt.max(a, b, c)         // returns latest
-datevolt.min(a, b, c)         // returns earliest
-datevolt.invalid()            // invalid datevolt instance
+datevolt.max(a, b, c)         // returns the latest date
+datevolt.min(a, b, c)         // returns the earliest date
+datevolt.invalid()            // returns an invalid datevolt instance
 datevolt.normalizeUnits('y')  // 'year'
 datevolt.version              // '1.0.1'
-datevolt.fn                   // prototype (for plugins)
+datevolt.fn                   // prototype — use for plugins
 ```
 
 ---
 
-## Migrating from moment.js
+## Familiar API
 
-Drop-in replacement in most cases — just change the import:
+If you've used any chainable date library before, datevolt will feel right at home. The API follows widely adopted conventions in the JavaScript date ecosystem — parse, format, add, subtract, diff, fromNow, and more — all chainable and consistent.
 
 ```js
-// Before
-const moment = require('moment');
-moment().format('YYYY-MM-DD');
-
-// After
-const datevolt = require('datevolt');
-datevolt().format('YYYY-MM-DD');
+// Switching from another date library? It's usually just a one-line change:
+// const datevolt = require('datevolt');
+// Then use it the same way you always have.
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datevolt",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "A complete, lightweight, zero-dependency date library with a moment.js-compatible API. Built for React Native CLI (Android & iOS), Node.js, and browsers.",
   "main": "src/index.js",
   "react-native": "src/index.js",