From dfb25ceae2b3212a4c17d8361143ba19f607dc49 Mon Sep 17 00:00:00 2001
From: davidpkj <davidpenkow1@gmail.com>
Date: Thu, 11 Apr 2024 19:38:55 +0200
Subject: readme

---
 README.adoc  | 12 ++++++++++++
 package.json |  2 +-
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.adoc b/README.adoc
index e69de29..ed9da74 100644
--- a/README.adoc
+++ b/README.adoc
@@ -0,0 +1,12 @@
+= Stundenplan
+
+A small JavaScript project to generate beautiful PDF schedules. Takes information from `src/variables.js`. Planning to use direct UnivIS-XML export.
+
+== Usage
+
+Requires the `npm` tool.
+
+```bash
+npm i # installes packages
+npm run main # runs the software
+````
diff --git a/package.json b/package.json
index 739d971..8afdaea 100644
--- a/package.json
+++ b/package.json
@@ -10,7 +10,7 @@
   },
   "devDependencies": {},
   "scripts": {
-    "test": "node src/main.js"
+    "main": "node src/main.js"
   },
   "author": "David Penkowoj",
   "license": "GPL-3.0-or-later",
-- 
cgit v1.2.3