Reorganise README.md

* Add .env.example
IPBachvarov18 · Jan 9, 2021 · f72ed0c · f72ed0c
1 parent 14a499b
commit f72ed0c
Show file tree

Hide file tree

Showing 12 changed files with 71 additions and 10 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,19 @@
+httpPort = 9999
+httpsPort = 8888
+hostname = localhost
+path = /
+method = POST
+pfxPath = ./Example.pfx
+passphrase = Example
+agent = false
+rejectUnauthorized = false
+er1 = /example
+ee1 = /example/example.html
+mailService = gmail
+gmailID = <Your Gmail Email>
+gmailPass = <Your Gmail Password>
+gmailHost = smtp.gmail.com
+gmailPORT = 465
+
+
+
diff --git a/.gitignore b/.gitignore
@@ -105,6 +105,6 @@ dist
 .tern-port
 
 # SSL certificate
-*.pfx
+certPK.pfx
 
 fikret/
diff --git a/Example.pfx b/Example.pfx
diff --git a/README.md b/README.md
@@ -1,12 +1,54 @@
-# Crypto Zargan
+<p align="center">
+  <img src="docs/logo.png" alt="Phantasma Logo" />
+</p> 
+<h1 align="center">ScaleFocus Project - Team Crypto Zargan</h1>
 
-<img src = "https://github.com/IPBachvarov18/CryptoZargan/blob/master/docs/logo.png">
+## Website
 
-## Team
+https://cryptozargan.studio
 
--   Ivelin Bachvarov - SCRUM Master
--   Iliyan Iliev - Developer
--   Emil Ribarev - Developer
--   Stoyan Kolev - QA
--   Georgi Georgiev - Code Checker / Designer
--   Mario Slavov - Documentary
+---
+
+We have implemented the Bletchley game with HTML / CSS / JS. Our project consists of singleplayer module and multiplayer module. The singleplayer includes three difficulties - Easy, Medium and Hard. The multiplayer allows one player to play as the Germans and create the code which the other player has to guess.
+
+## Technologies
+
+-   <img src="docs/html5.png" width="15px" height="15px"> HTML
+-   <img src="docs/css-3.png" width="15px" height="15px"> CSS
+-   <img src="docs/js.png" width="15px" height="15px"> JavaScript
+
+## Features
+
+-   [x] 3 singleplayer difficulties
+-   [x] Multiplayer mode
+-   [x] Bulgarian and English localisation
+
+---
+
+## How to run the project on your machine
+
+### Step 1: Clone the repository
+
+Open your terminal and clone the repository.
+
+```
+git clone https://github.com/IPBachvarov18/CryptoZargan.git
+cd CryptoZargan
+npm install
+```
+
+### Step 2: Rename `.env.example` to `.env`
+
+### Step 3: Enter your gmail account
+
+<img src="docs/gmail.png" alt="Step 3" />
+
+### Step 4: Run the project
+
+```
+node .
+```
+
+### Step 5: Go to `localhost:8888`
+
+<img src="docs/safe.png" alt="Step 3" />
diff --git a/docs/css-3.png b/docs/css-3.png
diff --git a/docs/gmail.png b/docs/gmail.png
diff --git a/docs/html.ico b/docs/html.ico
diff --git a/docs/html5.png b/docs/html5.png
diff --git a/docs/js.png b/docs/js.png
diff --git a/public/img/logo.png → docs/logo.png b/public/img/logo.png → docs/logo.png
diff --git a/docs/safe.png b/docs/safe.png
diff --git a/docs/step1-1.png b/docs/step1-1.png