diff --git a/README.md b/README.md index 218a426..ca5e327 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,29 @@ -The extension is based on https://github.com/Kocal/vue-web-extension boilerplate. +SimpleLogin Chrome/Firefox extension +--- -First install all dependencies with `npm install`. +SimpleLogin is the **open-source** privacy-first email alias and Single Sign-On (SSO) Identity Provider. -Then in dev mode, run `npm run watch:dev` to generate the `/dist` folder that can be installed into Chrome. +https://simplelogin.io + +The extension uses VueJS with https://github.com/Kocal/vue-web-extension boilerplate. + +## General information + +The extension consists of 3 main screens: + +- setup screen for first-time user. Here user can create and paste the `API Key` that's stored in `chrome.storage`. +- main screen: displays email alias recommendation, alias creation and existing alias. +- new alias screen: when a new alias is created, user is redirected to this screen so they can copy it. + +## Contributing Guide + +All work on SimpleLogin Chrome/Firefox extension happens directly on GitHub. + +To run the extension locally, please follow these steps: + +- install all dependencies with `npm install`. + +- run `npm run watch:dev` to generate the `/dist` folder that can be installed into Chrome. On Firefox, it can be done via `web-ext` tool from within the `/dist` folder: `cd dist/ && web-ext run`