diff --git a/README.md b/README.md index 51366e0..b6d603b 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,61 @@ This will fetch the content from https://example.com and return it in markdown f You can customize the request by changing the `X-Respond-With` header to other supported formats like `html`, `text`, `screenshot`, or `pageshot`. +## Docker Deployment + +You can deploy the Reader service using Docker in two ways: by building the image yourself or by pulling the pre-built image from GitHub Packages. + +### Option 1: Using the pre-built image + +1. Pull the latest image from GitHub Packages: + ```bash + docker pull ghcr.io/intergalacticalvariable/reader:latest + ``` + +2. Run the Docker container: + ```bash + docker run -p 3000:3000 ghcr.io/intergalacticalvariable/reader:latest + ``` + + This command runs the container and maps port 3000 of the container to port 3000 on your host machine. + +3. The service should now be accessible at `http://localhost:3000`. + +### Option 2: Building the image yourself + +If you prefer to build the image yourself or need to make modifications: + +1. Clone the repository: + ```bash + git clone https://github.com/intergalacticalvariable/reader.git + cd reader + ``` + +2. Build the Docker image: + ```bash + docker build -t reader . + ``` + +3. Run the Docker container: + ```bash + docker run -p 3000:3000 reader + ``` + +4. The service should now be accessible at `http://localhost:3000`. + +You can customize the Docker deployment by modifying the Dockerfile in the project root directory. + +## Usage + +Once the Docker container is running, you can use curl to make requests. For example: + +```bash +curl -H "X-Respond-With: markdown" http://localhost:3000/https://example.com +``` + +This will fetch the content from https://example.com and return it in markdown format. + +You can customize the request by changing the `X-Respond-With` header to other supported formats like `html`, `text`, `screenshot`, or `pageshot`. --- @@ -51,6 +106,17 @@ You can customize the request by changing the `X-Respond-With` header to other s Your LLMs deserve better input. +## Table of Contents +- [Features](#features) +- [Install and Setup](#install-and-setup) +- [Usage](#usage) +- [API Documentation](#api-documentation) +- [Updates](#updates) +- [Contributing](#contributing) +- [License](#license) + +## Features + Reader does two things: - **Read**: It converts any URL to an **LLM-friendly** input with `https://r.jina.ai/https://your.url`. Get improved output for your agent and RAG systems at no cost. - **Search**: It searches the web for a given query with `https://s.jina.ai/your+query`. This allows your LLMs to access the latest world knowledge from the web. @@ -205,5 +271,8 @@ curl -H "X-With-Generated-Alt: true" https://r.jina.ai/https://en.m.wikipedia.or ``` +## Contributing +We welcome contributions to Reader! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more details on how to get started. + ## License -[Apache-2.0](./LICENSE) \ No newline at end of file +This project is licensed under the [MIT License](LICENSE). \ No newline at end of file diff --git a/local-storage/instant-screenshots/pageshot-0400e182-1c36-412d-85f2-0b2ad840f065.png b/local-storage/instant-screenshots/pageshot-0400e182-1c36-412d-85f2-0b2ad840f065.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-0400e182-1c36-412d-85f2-0b2ad840f065.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-0e157303-d8b3-4f71-9f8e-33ba3fd9a698.png b/local-storage/instant-screenshots/pageshot-0e157303-d8b3-4f71-9f8e-33ba3fd9a698.png deleted file mode 100644 index b88ef07..0000000 Binary files a/local-storage/instant-screenshots/pageshot-0e157303-d8b3-4f71-9f8e-33ba3fd9a698.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-109ba972-1a0e-42ed-a994-c1b84edcb5cb.png b/local-storage/instant-screenshots/pageshot-109ba972-1a0e-42ed-a994-c1b84edcb5cb.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-109ba972-1a0e-42ed-a994-c1b84edcb5cb.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-2497b5f8-9560-42ec-9b23-3272b0d0f2dc.png b/local-storage/instant-screenshots/pageshot-2497b5f8-9560-42ec-9b23-3272b0d0f2dc.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-2497b5f8-9560-42ec-9b23-3272b0d0f2dc.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-3d2125dc-1baa-4b5d-9fab-e9e588a7855b.png b/local-storage/instant-screenshots/pageshot-3d2125dc-1baa-4b5d-9fab-e9e588a7855b.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-3d2125dc-1baa-4b5d-9fab-e9e588a7855b.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-44dd86cc-8257-4659-b4a7-80f11b5d7b0a.png b/local-storage/instant-screenshots/pageshot-44dd86cc-8257-4659-b4a7-80f11b5d7b0a.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-44dd86cc-8257-4659-b4a7-80f11b5d7b0a.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-93b6e8f2-0326-4aab-adb6-1b246913c7c4.png b/local-storage/instant-screenshots/pageshot-93b6e8f2-0326-4aab-adb6-1b246913c7c4.png deleted file mode 100644 index 6444f5f..0000000 Binary files a/local-storage/instant-screenshots/pageshot-93b6e8f2-0326-4aab-adb6-1b246913c7c4.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-94a998ae-69dd-4758-9311-0edd5d2f2740.png b/local-storage/instant-screenshots/pageshot-94a998ae-69dd-4758-9311-0edd5d2f2740.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-94a998ae-69dd-4758-9311-0edd5d2f2740.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-aa541fae-4cba-4632-b270-a37f20aecd3e.png b/local-storage/instant-screenshots/pageshot-aa541fae-4cba-4632-b270-a37f20aecd3e.png deleted file mode 100644 index 89be5ff..0000000 Binary files a/local-storage/instant-screenshots/pageshot-aa541fae-4cba-4632-b270-a37f20aecd3e.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-da6285a5-1d2f-4023-9a04-9a41c7678016.png b/local-storage/instant-screenshots/pageshot-da6285a5-1d2f-4023-9a04-9a41c7678016.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-da6285a5-1d2f-4023-9a04-9a41c7678016.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-dba8f147-a3e2-4e6e-a27b-42819243773a.png b/local-storage/instant-screenshots/pageshot-dba8f147-a3e2-4e6e-a27b-42819243773a.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-dba8f147-a3e2-4e6e-a27b-42819243773a.png and /dev/null differ diff --git a/local-storage/instant-screenshots/pageshot-f9c3b3d0-2a6b-4437-af28-74809e9e2513.png b/local-storage/instant-screenshots/pageshot-f9c3b3d0-2a6b-4437-af28-74809e9e2513.png deleted file mode 100644 index 2885066..0000000 Binary files a/local-storage/instant-screenshots/pageshot-f9c3b3d0-2a6b-4437-af28-74809e9e2513.png and /dev/null differ