Improved documentation

README.md

@@ -1 +1,39 @@
 # Website www.everestserver.pl
+
+Beautiful & responsive website for EverestServer.
+
+## A few words of introduction:
+This is a website I created for my home server. Currently, it serves as a hub, so that the users are able to select which service of the server they want to use.
+
+## Used technologies:
+* HTML
+* CSS
+* Sass
+* Bootstrap
+* JavaScript
+* jQuery
+
+## Prerequisites:
+* Install npm (it comes bundled with [Node.js](https://nodejs.org/en/download/))
+* Install [Sass](https://sass-lang.com/install)
+
+## How to set up locally?
+1. Clone the repository
+ ```
+ $ git clone "https://github.com/jonaszkadziela/everestserver.pl.git"
+ ```
+1. Enter **everestserver.pl** project directory
+ ```
+ $ cd everestserver.pl
+ ```
+1. Install all dependencies
+ ```
+ $ npm install
+ ```
+
+## Development:
+* File `assets/stylesheets/scss/main.scss` includes all other stylesheets and should be compiled into `assets/stylesheets/css/main.min.css`
+* Folder `assets/javascripts/` contains all JavaScript files which preferably should be compiled into one file `assets/javascripts/main.min.js`
+
+## Links:
+* Live website: https://www.everestserver.pl/

package.json

@@ -1,13 +1,14 @@
 {
  "name": "www.everestserver.pl",
  "version": "1.0.0",
- "description": "Website for EverestServer",
+ "description": "Beautiful & responsive website for EverestServer",
+ "author": "Jonasz Kądziela",
+ "private": true,
  "main": "index.html",
- "scripts": {
- "test": "echo \"Error: no test specified\" && exit 1"
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/jonaszkadziela/everestserver.pl/"
  },
- "author": "Jonasz Kadziela",
- "license": "ISC",
  "dependencies": {
  "bootstrap": "^4.1.3"
  }