diff --git a/README.md b/README.md index 337579a..01edc6e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ # envoy.com Webflow Website Scripts + +> :warning: **this repo is public**: Do not include any sensitive code here. + +## Intro + For hosting public scripts used on envoy.com webflow website + +These scripts are used for various purposes including but not limited to: + +- Handling what happens after form submissions (/utils/form-handlers.js) +- Table of contents on the blog +- Marketo CSS styles +- Calculator component on Virtual Front Desk page +- Trigger Chili Piper booking tool on events template pages + +## Setup + +The repo has a Github action (auto-tag.yml) to automatically manage versions. + +Versions are tracked in the .version file as an auto-incrementing integer. Each time you push code, the version will update by 1. + +Every time you push to the main branch, the Github action creates a tag. + +With the tag, you can create new releases and use jsdelivr to serve the scripts. + +for example, to use the form-handlers.js script you can use the following URL: + +``` +https://cdn.jsdelivr.net/gh/envoy/webflow-website@/src/utils/form-handlers.js +``` + +In Webflow site-wide custom code settings, you'll see this: + +``` + +``` + +It's a minimal approach to version control and serving scripts to the website.