Merge pull request #4 from TxtDot/readme

Readme

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 TxtDot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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).

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",

package.json

@@ -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"
 }