Merge pull request #62 from jankapunkt/refactor-file-structure

1.6.0

FUNDING.yml → .github/FUNDING.yml

@@ -2,7 +2,8 @@
 
 # These are supported funding model platforms
 
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+github:
+   - jankapunkt
 patreon: # Replace with a single Patreon username
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username

.github/workflows/tests.yml

@@ -14,24 +14,24 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [12, 14, 16]
+        node: [14, 16, 18]
     steps:
     - name: Checkout ${{ matrix.node }}
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup node ${{ matrix.node }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node }}
 
     - name: Cache dependencies ${{ matrix.node }}
-      uses: actions/cache@v1
+      uses: actions/cache@v3
       with:
         path: ~/.npm
         key: ${{ runner.os }}-node-${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
         restore-keys: |
           ${{ runner.os }}-node-${{ matrix.node }}
-    - run: cd package && npm ci
-    - run: cd package && npm run lint
-    - run: cd package && npm run test
+    - run: npm ci
+    - run: npm run lint
+    - run: npm run test:coverage
 

README.md

@@ -31,9 +31,20 @@ Set's prototype Methods are in contrast designed to work as a binary operation o
 Some algorithms may grow exponentially with a raising number of sets to be processes. 
 Please, see the documentation notes on the respective methods. 
 
+### Extending `Set`
+
+This package builds upon the `Set` implementation, instead of providing an own.
+Some suggest it's bad design to extend core implementations.
+
+However, the core functionality of `Set` is stable and proven and this
+package tries to be minimally invasive on the `Set` implementation.
+
+Please, leave an issue, in case this extension breaks your setup by
+whatever unexpected or undefined behaviour.
+
 ### Future Implementations
 
-Currently this package only supports finite sets. 
+Currently, this package only supports finite sets. 
 A future implementation could include generators to support infinite sets and function-based operations with infinite sets. Ideas.concepts and contributions are very welcomed.
 
 ## Installation and Usage
@@ -59,7 +70,7 @@ Set.__isExtended__ // true if this package is installed
 
 ## API Documentation
 
-There is a [markdown version](./api.md) and a [html version](https://jankapunkt.github.io/js-set-extension/) of the API documentation.
+There is a [markdown version](./API.md) and a [html version](https://jankapunkt.github.io/js-set-extension/) of the API documentation.
 If you think this documentation can be improved, please leave a pull request or open an issue.
 
 ## Run the tests