Commit 367052fc authored by Corentin Mors's avatar Corentin Mors
Browse files

Fix some readme mistakes

parent 382dd7ff
......@@ -5,16 +5,18 @@ A cross-platform instant and secure location sharing and chat.
## About this project
onMap aims to let users share their location safely with their friends.
onMap aims to let users share their location safely with their friends.
Websockets are used to instantly share locations between users, data is encrypted with AES using SHA-256 keys and random IV.
## How to use
You may test our running live server at [onMap PixelSwap Instance](https://onmap.pixelswap.fr/)
User chose a room, a username and a password. Anyone can join a room, but if you don't have the same password, you won't understand the others.
> /!\ Passwords are never sent to the server /!\
> Passwords are never sent to the server !
## Server and clients
......
[Dolphin]
Timestamp=2018,12,21,19,10,41
Version=4
ViewMode=1
......@@ -44,7 +44,7 @@ Install node packages :
Install gulp (and associated components) :
`npm install --global gulp-cli gulp-rename gulp-clean-css gulp-minify`
`npm install --global gulp gulp-cli`
If you have an error when starting `gulp`, you may have to link it to your project :
......@@ -63,11 +63,12 @@ or use Gulp automation so that any modifications to files will reload the app an
`gulp`
Your project is accessible at [localhost:1500](http://localhost:1500).
Your project is accessible at [localhost:1500](http://localhost:1500)
## Side Notes
- About crypto module, browserify is needed when applying any modifications to `crypto.js` file :
`browserify server/public/assets/crypto.js -o server/public/assets/crypto.bundle.js`
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment