doc: update information

This commit is contained in:
Artemy 2023-08-14 14:37:30 +03:00
parent b6851d2174
commit fb33669c67
3 changed files with 29 additions and 3 deletions

View File

@ -1,7 +1,29 @@
# txt.
HTTP proxy that parses only text, links and pictures from pages
reducing internet traffic, removing ads and heavy scripts.
## Installation
```bash
npm install
```
## Running
### Dev
```bash
npm run dev
```
### Prod
```bash
npm run build
npm run start
```
Uses [Mozilla's readability.js](https://github.com/mozilla/readability),
[JSDOM](https://github.com/jsdom/jsdom),
[Fastify web framework](https://github.com/fastify/fastify).

2
package-lock.json generated
View File

@ -7,7 +7,7 @@
"": {
"name": "txtdot",
"version": "1.0.0",
"license": "ISC",
"license": "MIT",
"dependencies": {
"@fastify/middie": "^8.3.0",
"@mozilla/readability": "^0.4.4",

View File

@ -30,6 +30,10 @@
"start": "node dist/app.js"
},
"keywords": [],
"author": "",
"license": "ISC"
"authors": [
"Artemy Egorov <me@artegoser.ru> https://github.com/artegoser",
"DarkCat09 <darkcat09@vivaldi.net> https://dc09.ru/",
"megahomyak https://github.com/megahomyak"
],
"license": "MIT"
}