Improved README.md

Added console logs to indicate that the server started
emmaexe · Feb 7, 2023 · 24cc1f7 · 24cc1f7
1 parent 1ce0d2f
commit 24cc1f7
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
   </a>
 </p>
 
-> A notification server for Anilist that uses ntfy.
+> A push notification server for Anilist. Fetches data from the anilist API, parses it and delivers push notifications to your device using ntfy.
 
 ### 🏠 [Repository](https://github.com/emmaexe/anilist-notifications)
 
@@ -21,6 +21,8 @@
 - NodeJS 18.x
   - node-fetch
 
+> ℹ️ To recieve push notifications, you need to install ntfy and subscribe to them. More info avaliable [here](https://ntfy.sh/).
+
 ## **Installation**
 
 Download or clone the [latest release](https://github.com/emmaexe/anilist-notifications/releases/latest).

diff --git a/config.js b/config.js
@@ -47,6 +47,7 @@ module.exports = {
 								'token': tokenfile.token,
 								'expires': tokenfile.expires
 							}
+							console.log('Anilist-notifications ready!')
 							return;
 						}
 					}

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "anilist-notifications",
-  "version": "1.0.0",
-  "description": "A notification server for Anilist that uses ntfy.",
+  "version": "1.0.1",
+  "description": "A push notification server for Anilist. Fetches data from the anilist API, parses it and delivers push notifications to your device using ntfy.",
   "author": "emmaexe",
   "main": "server.js",
   "dependencies": {

diff --git a/server.js b/server.js
@@ -1,3 +1,4 @@
+console.log('Anilist-notifications started!')
 const fetch = require('node-fetch')
 const fs = require('fs')
 const { configClass, query } = require('./config.js')