From 16584648deffc5f77f1a7357231f629aadda0a64 Mon Sep 17 00:00:00 2001
From: dylan_banta <dylanbanta@gmail.com>
Date: Thu, 22 Dec 2022 09:27:01 -0500
Subject: [PATCH] Added Readme

---
 README.md  | 17 +++++++++++++++++
 _Config.gs |  5 +++++
 2 files changed, 22 insertions(+)
 create mode 100644 README.md
 create mode 100644 _Config.gs

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..85f84b7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Google Docs QRIfy
+
+This project looks for instances of `<<QR>>` within a Google Doc and replaces them with that Google Doc's URL as a QR code.
+
+## Setup
+Before use, you will need to copy the `_Config.gs` file and rename the copy to `Config.gs`.
+
+Inside the Config.gs file, you need to add your private API token from: [https://app.qr-code-generator.com/api/](https://app.qr-code-generator.com/api/).
+
+Once you have obtained your API token, add it to the Config.gs file like so:
+
+
+`var token = "YOUR_API_TOKEN_HERE"; //Variable is global`
+
+## Usage
+
+To use the QR Code Generator, first open your Google Doc and go to the menu at the top. Select "Extension" and then "QR". From the dropdown menu, select "Replace `<<QR>>` with QR Code". This will replace any instances of `<<QR>>` within the Google Doc with a QR code containing the URL of the current Google Doc.
\ No newline at end of file
diff --git a/_Config.gs b/_Config.gs
new file mode 100644
index 0000000..fac6149
--- /dev/null
+++ b/_Config.gs
@@ -0,0 +1,5 @@
+//DO NOT UPLOAD THIS FILE TO GITHUB
+//MAKE SURE TO RENAME THIS FILE FROM _Config.gs TO Config.GS WITHOUT THE UNDERSCORE
+
+//Private API Token From https://app.qr-code-generator.com/api/
+var token = "YOUR_API_TOKEN_HERE"; //Variable is global
\ No newline at end of file