diff --git a/README.md b/README.md index 265c15b..7c95215 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +## Installation + +This extension can be installed directly via [Chrome](https://chrome.google.com/webstore/detail/reveddit-real-time/hickjbodophomfmdfhhnmdfbfoamcjje) or [Firefox](https://addons.mozilla.org/en-US/firefox/addon/reveddit-real-time/) or by cloning this repository and loading the dist-chrome/ or dist-firefox/ folder. + ## Dev: Hot reloading Chrome: Run `yarn start`, load `dist-dev-chrome/` in the browser, and visit a targeted content URL. Subsequent code changes will rebuild the code, reload the extension in the browser, and reload any impacted tabs. @@ -11,3 +15,8 @@ Firefox: `yarn start-firefox`, load `dist-dev-firefox/` ## Dev: Production build `yarn build-prod` builds Chrome and Firefox code and packages it into zip files. + +## Future work + +* Monitor parent comments / posts of subscribed users' comments + other subscribed comments +* Track edits to parent comments