From 969daeb99ed5a51e9a9970e31a94d02c1e52ff88 Mon Sep 17 00:00:00 2001 From: Keannu Bernasol Date: Sun, 23 Jul 2023 22:41:34 +0800 Subject: [PATCH] Updated README.md --- README.md | 30 +++++++++--------------------- 1 file changed, 9 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 1ebe379..f77c083 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,15 @@ -# React + TypeScript + Vite +# A simple web redirect to allow users to open links in-app -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +To use the deployed app, -Currently, two official plugins are available: +# Sample Usage -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +Have your activation email redirect a link like below +https://lemeow125.github.io/simple-redirect/#/stude/activation/MUID/12asdSDFGSDTSDFG -## Expanding the ESLint configuration +This will open the "activation" page/screen of our mobile app, pass the UID slug value of "MUID" and activation slug value of "12asdSDFGSDTSDFG +" -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: +"stude" in the example above must correspond to the name of your mobile app -- Configure the top-level `parserOptions` property like this: - -```js - parserOptions: { - ecmaVersion: 'latest', - sourceType: 'module', - project: ['./tsconfig.json', './tsconfig.node.json'], - tsconfigRootDir: __dirname, - }, -``` - -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list +Powered by Vite, ReactJS, and React Router