diff --git a/README.md b/README.md index 9634e04..1b9ab4c 100644 --- a/README.md +++ b/README.md @@ -42,10 +42,35 @@ After you have installed Java, download the latest release from the Releases sec After you have download the archive, unzip it and double click the .jar to use! +## Usage + +When you open the .jar file, you will see a window like this: + +![An image of the application](images/main-screenshot.png) + +The URL section is where you put the website you want to scrape emails or links from + +The Browser dropdown is where you choose the browser to use. You should use the one installed on your system. + +After you fill a link, you can scrape links or emails by clicking the buttons at the bottom. + +### Filters + +You can add filters to exclude certain emails/links from export. + +A filter is typically a text file containing content like this: + +```text +https://google.com +test@example.com +``` + +Every excluded link/email should be in a new line for it to work as intended. + ## Planned features - [ ] Go through a list of links to scrape more links/emails -- [ ] Filters +- [x] Filters - [ ] Notifying the user when scraping is done - [x] Dark mode diff --git a/build.clj b/build.clj index 2ab2114..f3a4f94 100644 --- a/build.clj +++ b/build.clj @@ -5,7 +5,7 @@ (def jar-content (str build-directory "/resources")) (def basis (b/create-basis {:project "deps.edn"})) -(def version "1.0.0") +(def version "1.0.1") (def app-name "mail-harvester") (def uber-file-name (format "%s/%s-%s-standalone.jar" build-directory app-name version)) @@ -15,9 +15,6 @@ (defn uber [_] (clean nil) - (b/copy-file {:src "README.md" - :target-dir build-directory}) - (b/compile-clj {:basis basis :src-dirs ["src"] :class-dir jar-content}) diff --git a/images/main-screenshot.png b/images/main-screenshot.png new file mode 100644 index 0000000..8579740 Binary files /dev/null and b/images/main-screenshot.png differ