diff --git a/.csslintrc b/.csslintrc new file mode 100644 index 0000000..830ea91 --- /dev/null +++ b/.csslintrc @@ -0,0 +1,5 @@ +{ + "box-model": false, + "box-sizing": false, + "outline-none": false +} diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..9b1c8b1 --- /dev/null +++ b/.eslintignore @@ -0,0 +1 @@ +/dist diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..40a8060 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,23 @@ +{ + "parserOptions": { + "ecmaVersion": 8, + "sourceType": "module" + }, + "plugins": ["prettier"], + "extends": ["plugin:prettier/recommended"], + "rules": { + "prettier/prettier": [ + "error", + { + "semi": true, + "singleQuote": true, + "printWidth": 125, + "tabWidth": 4, + "useTabs": false, + "trailingComma": "none", + "bracketSpacing": true, + "parser": "flow" + } + ] + } +} diff --git a/.eslintrc.json b/.eslintrc.json deleted file mode 100644 index f6bd46b..0000000 --- a/.eslintrc.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "env": { - "browser": true, - "es2020": true - }, - "extends": [ - "airbnb-base" - ], - "parser": "@typescript-eslint/parser", - "parserOptions": { - "ecmaVersion": 2020, - "sourceType": "module" - }, - "plugins": [ - "@typescript-eslint" - ], - "rules": { - } -} diff --git a/.gitignore b/.gitignore index 6ebed66..e8f5506 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,7 @@ -node_modules +/node_modules .DS_Store -.cache -yarn.lock \ No newline at end of file +.eslintrc.json +.vscode +serve +compile +publish diff --git a/README.md b/README.md index 2b78c88..7eeab11 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,59 @@ -# 📧 mailymaily +
+ + + +
-## Usage -### CC -`data-cc-address` and `data-cc-domain` to recreate cc: `data-cc-address@data-cc-domain` -### BCC -`data-bcc-address` and `data-bcc-domain` to recreate bcc: `data-bcc-address@data-bcc-domain` -### Subject -`data-subject` for the subject of the email -### Body -`data-body` for the body of the email +A simple way to enhance your mailto links with a convenient user interface.
-## Dev -### Dependencies -``` -yarn + + +## Introduction + +MailtoUI is a JavaScript library that enhances your mailto links with a convenient user interface. It gives your users the flexibility to compose a new message using a browser-based email client or their default local email app. + +MailtoUI is ideal for static sites or any other site where you don't want to spend time setting up a "Contact Us" form solution. + +## Quick Setup + +### STEP 1 + +Add MailtoUI via CDN to the bottom of your page, just before the closing ` + ... + ... + +