Merge pull request #199 from sebgroup/new-release-with-breaking-changes

New release with breaking changes

Author: yousifalraheem

.github/workflows/build-check.yml

@@ -2,27 +2,20 @@ name: Build Check
 
 on:
   pull_request:
-    branches: 
-      - master
-      - develop
+    branches: [ master, develop ]
 
 jobs:
   build_check:
-    runs-on: [ubuntu-latest]
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '10', '8' ]
+        node: [ '14', '13', '12' ]
     steps:
-      - uses: actions/checkout@v2.0.0
-      - name: Setup node
-        uses: actions/setup-node@v1.1.0
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
         with:
-          node-version: ${{ matrix.node }}
-      - name: installing dependencies
-        run: npm install
-      - name: checking lint
-        run: npm run lint
-      - name: running unit tests
-        run: npm test
-      - name: building
-        run: npm run build:production
+          version: ${{ matrix.node }}
+      - run: npm ci
+      - run: npm run lint
+      - run: npm test
+      - run: npm run build

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: CI
+name: Release
 
 on:
   push:
@@ -7,40 +7,27 @@ on:
 
 jobs:
   publish:
-
-    runs-on: [ubuntu-latest]
-
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2.0.0
-
-    - name: Setup node
-      uses: actions/setup-node@v1.1.0
-      with:
-        node-version: '10.x'
-
-    - name: installing dependencies
-      run: npm ci
-
-    - name: building
-      run: npm run build
-    
-    - name: preparing to publish
-      run: npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
-      env:
-        CI: true
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-    - name: semantic release
-      run: npm run semantic-release
-      env:
-        CI: true
-        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-        GH_TOKEN: ${{ secrets.GH_TOKEN }}
-        NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        
-    - name: publish coverage
-      uses: coverallsapp/github-action@v1.0.1
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-      env:
-        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          version: 12
+      - run: npm ci
+      - run: npm test
+      - run: npm run build
+      - run: npm config set //registry.npmjs.org/:_authToken=$NPM_TOKEN
+        env:
+          CI: true
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 
+      - run: npm run semantic-release
+        env:
+          CI: true
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - uses: coverallsapp/github-action@v1.1.1
+        with:
+          github-token: $${{ secrets.GH_TOKEN }}
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_TOKEN }}

README.md

@@ -1,33 +1,45 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
-[![Build Status](https://github.com/sebgroup/frontend-tools/workflows/CI/badge.svg)](https://github.com/sebgroup/frontend-tools/actions?query=workflow%3ACI)
 [![Coverage Status](https://coveralls.io/repos/github/sebgroup/frontend-tools/badge.svg?branch=master)](https://coveralls.io/github/sebgroup/frontend-tools?branch=master)
 [![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=sebgroup/frontend-tools)](https://dependabot.com)
+[![npm version](https://badge.fury.io/js/%40sebgroup%2Ffrontend-tools.svg)](https://www.npmjs.com/package/@sebgroup/frontend-tools)
+![tree shakable](https://img.shields.io/badge/%F0%9F%8C%B2-tree--shakable-brightgreen)
+
 
 # **Frontend tools**
 
 A set of frontend utilities that can be used with any javascript application. It's lightweight and intuitive.
 
+This library is **tree-shakable** 🎉.
+
 ## **Installation**
 
+### npm
+
 ```terminal
 npm install @sebgroup/frontend-tools
 ```
 
+### yarn
+
+```terminal
+yarn add @sebgroup/frontend-tools
+```
+
 ## **Usage**
 
 Using `isStrongPassword` utility as an example, this is how you import it:
 
 ### ES6
 
 ```typescript
-import { isStrongPassword } from "@sebgroup/frontend-tools/dist/isStrongPassword";
+import { isStrongPassword } from "@sebgroup/frontend-tools";
 ```
 
 ### ES5
 
 ```typescript
-const isStrongPassword = require("@sebgroup/frontend-tools/dist/isStrongPassword");
+const isStrongPassword = require("@sebgroup/frontend-tools");
 ```
 
 ## **How to contribute**