Skip to content

Commit

Permalink
updated documentation (#91)
Browse files Browse the repository at this point in the history
* updated documentation

* add performance keyword

* add fast keyword
  • Loading branch information
kubikowski authored May 30, 2024
1 parent a487203 commit aa995d4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
[![Zipped Size][]][bundle phobia]
[![Language][]][typescript]

This library is a collection of high performance utilities from Set Theory,
which operate on an arbitrary number of Sets by each accepting variable arguments.
High performance set theory.

Each utility function operates with the principals of immutability:
none of the input sets are modified in the process or result of calculation.
This library is a collection of functional utilities from set theory,
each of which operate on an arbitrary number of input sets.

Each function accepts variable arguments and operates with the principals of immutability:
none of the input sets are modified in the process of calculation.


## Set Operations:
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "1.5.6",
"author": "Nathaniel Holden <holden@inanity.io> (https://inanity.io)",
"homepage": "https://github.com/kubikowski/set-utilities",
"description": "A collection of high performance utilities from Set Theory, which operate on an arbitrary number of Sets.",
"description": "High performance set theory - functional utilities which operate on arbitrary input sets.",
"license": "MIT",
"keywords": [
"set",
Expand All @@ -19,9 +19,9 @@
"disjoint",
"subset",
"superset",
"performance",
"fast",
"utilities",
"utility",
"utils",
"util"
],
"repository": {
Expand Down

0 comments on commit aa995d4

Please sign in to comment.