Add readme

audienceproject · Mar 25, 2020 · 572672e · 572672e
1 parent 97d2fad
commit 572672e
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+/node_modules/
+/package-lock.json
+/yarn.lock
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# TCStringParse
+
+Simple parser for transparency and consent strings compatible with TCF2.0.
+
+## Installation
+
+`npm install tc-string-parse`
+
+## Usage
+
+### NodeJS
+
+```js
+const TCStringParse = require('tc-string-parse');
+
+const consentString = ''; // your consent string
+TCStringParse(consentString);
+```
+
+### Browser
+
+```html
+<script src="path/to/tc-string-parse.js"></script>
+
+<script>
+  const consentString = ''; // your consent string
+  TCStringParse(consentString);
+</script>
+```