From 572672e1381b514b2f1f813076315006ffacf050 Mon Sep 17 00:00:00 2001
From: Nikolay Frantsev <nf@audienceproject.com>
Date: Wed, 25 Mar 2020 10:44:44 +0200
Subject: [PATCH] Add readme

---
 .gitignore |  3 +++
 README.md  | 29 +++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..b16fdf4
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+/node_modules/
+/package-lock.json
+/yarn.lock
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..038962d
--- /dev/null
+++ 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>
+```