Update README

- Remove deprecated badges
- Add CJS Compatibility which also links to ESM version
- Set project URL to common-js branch

Author: Borewit

README.md

@@ -1,18 +1,21 @@
-![Node.js CI](https://github.com/Borewit/token-types/workflows/Node.js%20CI/badge.svg)
+[![Node.js CI](https://github.com/Borewit/token-types/actions/workflows/nodejs-ci.yml/badge.svg)](https://github.com/Borewit/token-types/actions/workflows/nodejs-ci.yml)
 [![NPM version](https://badge.fury.io/js/token-types.svg)](https://npmjs.org/package/token-types)
 [![npm downloads](http://img.shields.io/npm/dm/token-types.svg)](https://npmcharts.com/compare/token-types,strtok3?start=1200&interval=30)
 [![coveralls](https://coveralls.io/repos/github/Borewit/token-types/badge.svg?branch=master)](https://coveralls.io/github/Borewit/token-types?branch=master)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/4723ce4613fc49cda8db5eed29f18834)](https://www.codacy.com/app/Borewit/token-types?utm_source=github.com&utm_medium=referral&utm_content=Borewit/token-types&utm_campaign=Badge_Grade)
-[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Borewit/token-types.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/token-types/context:javascript)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/Borewit/token-types.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Borewit/token-types/alerts/)
 [![DeepScan grade](https://deepscan.io/api/teams/5165/projects/6940/branches/61852/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=5165&pid=6940&bid=61852)
 [![Known Vulnerabilities](https://snyk.io/test/github/Borewit/token-types/badge.svg?targetFile=package.json)](https://snyk.io/test/github/Borewit/token-types?targetFile=package.json)
 
-# token-types
+# token-types CommonJS version
 
 A primitive token library used to read and write from a node `Buffer`.
 Although it is possible to use this module directly, it is primary designed to be used with [strtok3 tokenizer](https://github.com/Borewit/strtok3).
 
+## Compatibility
+
+This is the deprecated [CommonJS](https://en.wikipedia.org/wiki/CommonJS) module version of token-types. 
+Strongly recommended to use the [ESM version, version ≥ 5](https://github.com/Borewit/token-types) instead.
+
 ## Installation
 
 ```sh
@@ -36,7 +39,7 @@ npm install --save-dev @tokenizer/token
 ```js
 const strtok3 = require('strtok3');
 const token = require('token-types');
-    
+
 (async () => {
 
   const tokenizer = await strtok3.fromFile("somefile.bin");
@@ -45,7 +48,7 @@ const token = require('token-types');
     console.log(`My number: ${myNumber}`);
   } finally {
     tokenizer.close(); // Close the file
-  } 
+  }
 })();
 ```
 

package.json

@@ -27,7 +27,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Borewit/token-types"
+    "url": "https://github.com/Borewit/token-types/tree/commonjs"
   },
   "files": [
     "lib/index.js",