diff --git a/README.md b/README.md index a9020b3..63cea67 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # mealie-extension -A Firefox extension to easily add recipes to a personal Mealie instance. \ No newline at end of file +A Firefox extension to easily add recipes to a personal Mealie instance. + +**Note: This is currently in alpha. Please use at your own risk** + +*How to use* + +Install through Firefox marketplace (pending approval) or use extension debug to install manually as a temp extension. + +Once installed, go to preferences and your Mealie URL and the API token you will be using (this needs to be generated from your account on Mealie). + +After that, either right-click a page or use shortcut "Ctrl+Alt+M". \ No newline at end of file