Skip to content

Commit

Permalink
Added readme with screnshots
Browse files Browse the repository at this point in the history
  • Loading branch information
rickoooooo committed Feb 8, 2023
1 parent e2705d1 commit 4097930
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added screenshots/2023-02-08-08-41-31.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/2023-02-08-08-41-56.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/2023-02-08-08-43-03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/2023-02-08-08-43-48.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/2023-02-08-08-45-24.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/2023-02-08-08-54-06.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4097930

Please sign in to comment.