Skip to content

Commit

Permalink
doc: features
Browse files Browse the repository at this point in the history
  • Loading branch information
artegoser committed Mar 5, 2024
1 parent a7fdaf8 commit 76eb9db
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 6 deletions.
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,28 @@
HTTP proxy that parses only text, links and pictures from pages
reducing internet traffic, removing ads and heavy scripts.

Uses [Mozilla's readability.js](https://github.com/mozilla/readability),
[🔗 linkedom](https://github.com/WebReflection/linkedom),
[Fastify web framework](https://github.com/fastify/fastify).
## Features

- Search with SearXNG
- Image compression with Sharp
- Server side page simplification
- Page to view parsed data
- Custom engines for stackoverflow, searxng
- API for parsing pages

## Interface

![interface_url](./docs/interface_url.png)
![interface_search_page](./docs/interface_search_page.png)

## Development

## Installation
### Installation

```bash
npm install
```

## Running

### Dev

```bash
Expand All @@ -43,3 +53,16 @@ npm run start
docker compose build
docker compose up -d
```

## Credits

Uses [Mozilla's readability.js](https://github.com/mozilla/readability),
[🔗 linkedom](https://github.com/WebReflection/linkedom),
[Fastify web framework](https://github.com/fastify/fastify),
[EJS](https://github.com/mde/ejs),
[Axios](https://github.com/axios/axios),
[DomPurify](https://github.com/cure53/DOMPurify),
[Sharp](https://github.com/lovell/sharp),
[MicroMatch](https://github.com/micromatch/micromatch),
[RouteParser](https://github.com/rcs/route-parser),
[IconvLite](https://github.com/ashtuchkin/iconv-lite)
Binary file added docs/interface_search_page.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 docs/interface_url.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 76eb9db

Please sign in to comment.