From fb33669c6793bba45573d978284b1852b9555324 Mon Sep 17 00:00:00 2001 From: Artemy Date: Mon, 14 Aug 2023 14:37:30 +0300 Subject: [PATCH] doc: update information --- README.md | 22 ++++++++++++++++++++++ package-lock.json | 2 +- package.json | 8 ++++++-- 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bd0fb54..3c3ec73 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/package-lock.json b/package-lock.json index a5787c8..efab8ef 100644 --- a/package-lock.json +++ b/package-lock.json @@ -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", diff --git a/package.json b/package.json index e4722ea..b6cf40c 100644 --- a/package.json +++ b/package.json @@ -30,6 +30,10 @@ "start": "node dist/app.js" }, "keywords": [], - "author": "", - "license": "ISC" + "authors": [ + "Artemy Egorov https://github.com/artegoser", + "DarkCat09 https://dc09.ru/", + "megahomyak https://github.com/megahomyak" + ], + "license": "MIT" }