doc: update information
This commit is contained in:
parent
b6851d2174
commit
fb33669c67
22
README.md
22
README.md
@ -1,7 +1,29 @@
|
|||||||
# txt.
|
# txt.
|
||||||
|
|
||||||
HTTP proxy that parses only text, links and pictures from pages
|
HTTP proxy that parses only text, links and pictures from pages
|
||||||
reducing internet traffic, removing ads and heavy scripts.
|
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),
|
Uses [Mozilla's readability.js](https://github.com/mozilla/readability),
|
||||||
[JSDOM](https://github.com/jsdom/jsdom),
|
[JSDOM](https://github.com/jsdom/jsdom),
|
||||||
[Fastify web framework](https://github.com/fastify/fastify).
|
[Fastify web framework](https://github.com/fastify/fastify).
|
||||||
|
2
package-lock.json
generated
2
package-lock.json
generated
@ -7,7 +7,7 @@
|
|||||||
"": {
|
"": {
|
||||||
"name": "txtdot",
|
"name": "txtdot",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"license": "ISC",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@fastify/middie": "^8.3.0",
|
"@fastify/middie": "^8.3.0",
|
||||||
"@mozilla/readability": "^0.4.4",
|
"@mozilla/readability": "^0.4.4",
|
||||||
|
@ -30,6 +30,10 @@
|
|||||||
"start": "node dist/app.js"
|
"start": "node dist/app.js"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"authors": [
|
||||||
"license": "ISC"
|
"Artemy Egorov <me@artegoser.ru> https://github.com/artegoser",
|
||||||
|
"DarkCat09 <darkcat09@vivaldi.net> https://dc09.ru/",
|
||||||
|
"megahomyak https://github.com/megahomyak"
|
||||||
|
],
|
||||||
|
"license": "MIT"
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user