Skip to content

Commit d2a0eac

Browse files
authored
Merge pull request #82 from bjuppa/improve-docs
Improve docs
2 parents b26972c + ef1f4ea commit d2a0eac

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ objects don't handle timezones very well.
66

77
ComPlainDate is a collection of tools for **expressive and timezone-safe
88
manipulation of dates and times** on top of the JavaScript features already
9-
available in today's browsers and runtime systems.
9+
available in today's browsers and runtime systems. The package is
10+
dependency-free and supports tree-shaking, making production bundle size
11+
increase as little as `1 kB` for most projects.
1012

11-
The central idea in ComPlainDate is to provide timezone-agnostic
13+
The central idea in ComPlainDate is to provide immutable timezone-agnostic
1214
[`PlainDate`](#plaindate-for-calendar-dates) and
1315
[`PlainTime`](#plaintime-for-time-of-day) objects with composable utility
1416
functions for common calendar and time related operations.
@@ -560,11 +562,11 @@ utilities outside of ComPlainDate.
560562
### Composable functions
561563

562564
Inspired by concepts from functional programming, functions are pure and
563-
composable and all operations requiring multiple arguments are implemented as
565+
composable and operations requiring multiple arguments are implemented as
564566
higher-order functions for currying.
565567

566-
Also, there are no classes here, only objects adhering to interfaces and
567-
accompanying factory functions to create them.
568+
Also, there are no classes here, only immutable objects adhering to interfaces
569+
and accompanying factory functions to create them.
568570

569571
Please don't let this scare you, the ComPlainDate utilities are just as easy to
570572
use in a non-functional paradigm too!

0 commit comments

Comments
 (0)