diff --git a/README.md b/README.md index 62698d4..2f71ad7 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # IndexThis -An Android app that allows you to index a URL to a YaCy instance. You can "share" a URL from a browser or wherever and choose the indexing depth. +IndexThis is an Android app that allows you to index a URL to a YaCy instance. You can "share" a URL from a browser or other application and choose the indexing depth. You can also manually paste a URL into IndexThis for indexing. + +# Screenshots +## Home Screen +![Home Screen](./screenshots/2023-02-08-08-41-56.png) + +## Options Screen +![Options Screen](./screenshots/2023-02-08-08-41-31.png) + +# Usage +Use your browser's "share" functionality to share the current URL with the IndexThis app. +## Firefox Example +First, click the Firefox menu button. +![Firefox Menu Button](./screenshots/2023-02-08-08-43-03.png) + +Next, click the "share" button. +![Firefox Share Button](./screenshots/2023-02-08-08-43-48.png) + +Then, choose "IndexThis" +![Share to IndexThis](./screenshots/2023-02-08-08-45-24.png) + +Finally, set your index depth and click "Index This!" +![Index It](./screenshots/2023-02-08-08-54-06.png) + +## Contributions +If you find IndexThis useful and want to make changes, feel free to make a pull request. I'm trying to keep the app as simple as possible. The main area it needs help is in UI design and compatibility with other devices. I've only tested it on my Pixel 4a so far and only in portrait mode. \ No newline at end of file diff --git a/screenshots/2023-02-08-08-41-31.png b/screenshots/2023-02-08-08-41-31.png new file mode 100644 index 0000000..3859a42 Binary files /dev/null and b/screenshots/2023-02-08-08-41-31.png differ diff --git a/screenshots/2023-02-08-08-41-56.png b/screenshots/2023-02-08-08-41-56.png new file mode 100644 index 0000000..7431c39 Binary files /dev/null and b/screenshots/2023-02-08-08-41-56.png differ diff --git a/screenshots/2023-02-08-08-43-03.png b/screenshots/2023-02-08-08-43-03.png new file mode 100644 index 0000000..e39cbf0 Binary files /dev/null and b/screenshots/2023-02-08-08-43-03.png differ diff --git a/screenshots/2023-02-08-08-43-48.png b/screenshots/2023-02-08-08-43-48.png new file mode 100644 index 0000000..0152c5b Binary files /dev/null and b/screenshots/2023-02-08-08-43-48.png differ diff --git a/screenshots/2023-02-08-08-45-24.png b/screenshots/2023-02-08-08-45-24.png new file mode 100644 index 0000000..526935a Binary files /dev/null and b/screenshots/2023-02-08-08-45-24.png differ diff --git a/screenshots/2023-02-08-08-54-06.png b/screenshots/2023-02-08-08-54-06.png new file mode 100644 index 0000000..56a7af2 Binary files /dev/null and b/screenshots/2023-02-08-08-54-06.png differ