Skip to content

Commit 4da9c45

Browse files
committed
Update README
- Remove deprecated badges - Link to ESM version, add deprecation note
1 parent c7c32e5 commit 4da9c45

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
![Node.js CI](https://github.com/Borewit/token-types/workflows/Node.js%20CI/badge.svg)
1+
[![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)
22
[![NPM version](https://badge.fury.io/js/token-types.svg)](https://npmjs.org/package/token-types)
33
[![npm downloads](http://img.shields.io/npm/dm/token-types.svg)](https://npmcharts.com/compare/token-types,strtok3?start=1200&interval=30)
44
[![coveralls](https://coveralls.io/repos/github/Borewit/token-types/badge.svg?branch=master)](https://coveralls.io/github/Borewit/token-types?branch=master)
55
[![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)
6-
[![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)
7-
[![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/)
86
[![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)
97
[![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)
108

11-
# token-types
9+
# token-types CommonJS version
10+
11+
_This is the deprecated [CommonJS](https://en.wikipedia.org/wiki/CommonJS) module version of token-types. Consider to use the [ESM version](https://github.com/Borewit/token-types)._
1212

1313
A primitive token library used to read and write from a node `Buffer`.
1414
Although it is possible to use this module directly, it is primary designed to be used with [strtok3 tokenizer](https://github.com/Borewit/strtok3).
@@ -36,7 +36,7 @@ npm install --save-dev @tokenizer/token
3636
```js
3737
const strtok3 = require('strtok3');
3838
const token = require('token-types');
39-
39+
4040
(async () => {
4141

4242
const tokenizer = await strtok3.fromFile("somefile.bin");
@@ -45,7 +45,7 @@ const token = require('token-types');
4545
console.log(`My number: ${myNumber}`);
4646
} finally {
4747
tokenizer.close(); // Close the file
48-
}
48+
}
4949
})();
5050
```
5151

0 commit comments

Comments
 (0)