Merge pull request #27 from thoughtsunificator/develop

Fix

Author: thoughtsunificator

.env.sample.json

@@ -30,6 +30,8 @@
   ],
 	"rules": {
 		"require-await": "warn",
+		"require-jsdoc": "warn",
+		"valid-jsdoc": ["warn", { "requireParamDescription": false, "requireReturn": false, "requireReturnDescription": false }],
 		"comma-style": [1, "last"],
 		"curly": [1, "multi-line"],
 		"eol-last": [1, "always"],

.eslintrc.json

@@ -1,4 +1,4 @@
-# instagram-dm-unsender
+# instagram-dm-unsender (idmu)
 
 As of 2023 [instagram.com](https://www.instagram.com) does not allow batch unsending of messages which is why this project came to be.
 
@@ -19,9 +19,19 @@ Deleting a thread will only delete messages on your end, the other party will st
 
 Unsending a thread on the other hand will delete messages on both ends, the other party will no longer be able to read your messages.
 
-## How does it work?
+## How does it work / How can I use it?
 
-This script is meant to be run on the page that lists the message threads.
+This script is meant to be run on the page that lists the message threads. 
+
+** The UI will only appear once you select a message thread ** :
+
+![UI Preview](preview.png)
+
+From here three buttons are available :
+
+- Unsend all DMs - Start the unsending workflow
+- Batch size - Change the number of page to load between unsending
+- Load all DMs - Load all your thread messages
 
 The workflow works as follow:
 - Create a list of all messages by querying the DOM with an early messages detection strategy (we test the raw outputs of our ``find-messages-strategy`` against parts of the workflow).
@@ -64,15 +74,19 @@ Finally, install the userscript from OpenUserJS :
 
 I recommend using [Violentmonkey](https://violentmonkey.github.io/) or similar and enable userscript autoreloading as explained in here https://violentmonkey.github.io/posts/how-to-edit-scripts-with-your-favorite-editor/ 
 
-Install all dependencies:
+Install dependencies:
 - ``npm install``
 
-Start rollup with the watch flag:
+To both serve and build with autoreloading:
 - ``npm start``
 
+> This will also start an HTTP server and allow autoreloading of the userscript as changes are made.
+
 You can also do a one-time build with:
 - ``npm run build``
 
+> The script will build to ``dist/idmu.user.js`` by default.
+
 ## This might not work
 
 Instagram web app is serving different UIs probably based on the user location. [Yours might not be supported](https://github.com/thoughtsunificator/instagram-dm-unsender/issues/1)