Skip to content

Commit 78590e3

Browse files
Update readme
1 parent a984761 commit 78590e3

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# TCStringParse
22

3-
Simple parser for transparency and consent strings compatible with TCF2.0.
3+
Simple JavaScript parser for transparency and consent strings compatible with TCF 2.0.
44

55
## Installation
66

7+
Parser is available as [NPM package](https://www.npmjs.com/package/tc-string-parse):
8+
79
`npm install tc-string-parse`
810

911
## Usage
@@ -14,16 +16,16 @@ Simple parser for transparency and consent strings compatible with TCF2.0.
1416
const TCStringParse = require('tc-string-parse');
1517

1618
const consentString = ''; // your consent string
17-
TCStringParse(consentString);
19+
const consentModel = TCStringParse(consentString);
1820
```
1921

20-
### Browser (IE 9+ with atob polyfill)
22+
### Browser (IE 9+ with [atob polyfill](https://caniuse.com/#feat=atob-btoa))
2123

2224
```html
2325
<script src="path/to/tc-string-parse.min.js"></script>
2426

2527
<script>
26-
const consentString = ''; // your consent string
27-
TCStringParse(consentString);
28+
var consentString = ''; // your consent string
29+
var consentModel = TCStringParse(consentString);
2830
</script>
2931
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "tc-string-parse",
3-
"description": "Simple parser for transparency and consent strings compatible with TCF2.0.",
3+
"description": "Simple JavaScript parser for transparency and consent strings compatible with TCF 2.0.",
44
"version": "1.1.1",
55
"repository": {
66
"type": "git",

0 commit comments

Comments
 (0)