From 99d5d395f30cd2b451c4490e4be11a6b2a1be306 Mon Sep 17 00:00:00 2001
From: Tobias Berger <tobi.berger13@gmail.com>
Date: Mon, 7 Feb 2022 10:11:59 +0100
Subject: [PATCH] Clean up package files

Add LICENSE, README.md, and improve package.json
---
 LICENSE      | 24 ++++++++++++++++++++++++
 README.md    | 31 +++++++++++++++++++++++++++++++
 package.json | 31 +++++++++++++++++--------------
 3 files changed, 72 insertions(+), 14 deletions(-)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..efb9808
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5820402
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Backend for Minimal Non-Persistent chat
+
+Built in TypeScript 4.5 with rollup
+
+## Install
+
+Run the command `yarn install`  
+(or the equivalent in your package manager of choice).
+
+## Build
+
+Run the command `yarn build`
+(or the equivalent in your package manager of choice).
+
+This will run rollup with the project's `rollup.config.js`.  
+Alternatively, you can run rollup manually without a package manager.  
+(cf. [rollup's guide](https://rollupjs.org/guide/) for a how-to)
+
+## Run
+
+Run the command `yarn start`
+(or the equivalent in your package manager of choice).
+
+The compiled script does not take any parameters.  
+Any configuration needs to be done in-source, before the [building step](#build).
+
+This will run the compiled JavaScript file with the environment's `node` executable.  
+Alternatively, manually run `<your node path>/node ./server.node.bundle.js`
+
+
+#### This package has only been tested on Linux.
diff --git a/package.json b/package.json
index 0086a5d..5ac1f1e 100644
--- a/package.json
+++ b/package.json
@@ -1,26 +1,28 @@
 {
   "name": "web-drs-backend",
   "version": "1.0.0",
-  "description": "",
+  "description": "Backend for a non-persistent minimal chat application",
+  "homepage": "https://home.tobot.dev/toby/web-drs-backend",
+  "bugs": {
+    "url": "https://home.tobot.dev/toby/web-drs-backend/issues",
+    "email": "tobi.berger13@gmail.com"
+  },
+  "license": "Unlicense",
+  "author": {
+    "name": "Tobias Berger"
+    "email": "tobi.berger13@gmail.com",
+    "url": "https://tobot.dev/"
+  },
   "main": "server.node.bundle.js",
-  "directories": {
-    "lib": "lib"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Toby222/web-drs-backend.git"
   },
   "scripts": {
     "prod": "yarn build && yarn start",
     "start": "node server.node.bundle.js",
     "build": "rollup --config ./rollup.config.js"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Toby222/web-drs-backend.git"
-  },
-  "author": "Tobias Berger <tobi.berger13@gmail.com>",
-  "license": "Unlicense",
-  "bugs": {
-    "url": "https://github.com/Toby222/web-drs-backend/issues"
-  },
-  "homepage": "https://github.com/Toby222/web-drs-backend#readme",
   "devDependencies": {
     "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-node-resolve": "^13.1.3",
@@ -30,5 +32,6 @@
     "rollup-plugin-typescript2": "^0.31.1",
     "typescript": "^4.5.4",
     "ws": "^8.4.2"
-  }
+  },
+  "private": true
 }