summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFreeyorp <TheFreeYorp@NOSPAM.G.m.a.i.l.replace>2013-05-13 01:04:15 +1200
committerFreeyorp <TheFreeYorp@NOSPAM.G.m.a.i.l.replace>2013-05-13 01:04:15 +1200
commit14618ab57d45ea94604b632f2ffb40b68657ac49 (patch)
tree7b74553f82b0efa022f47b3437792aa12c7fb3f5 /README.md
parent6db745b81a44f76c0d23c1464ef3aba018a925cd (diff)
downloadmanavis-14618ab57d45ea94604b632f2ffb40b68657ac49.tar.gz
manavis-14618ab57d45ea94604b632f2ffb40b68657ac49.tar.bz2
manavis-14618ab57d45ea94604b632f2ffb40b68657ac49.tar.xz
manavis-14618ab57d45ea94604b632f2ffb40b68657ac49.zip
Update README.md for npm instructions
Also make its description consistent with the one in index.html.
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 562099c..1839477 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
manavis
=======
-Manavis parses and visualises combat logs generated by the tmwAthena server.
+Manavis shows experience gain from combat logs generated by The Mana World's server, tmwAthena.
Manavis can operate in two modes, offline and online.
To run in offline mode, place the public/ folder in a location served by a web server, or run python -m SimpleHTTPServer from it, and connect to localhost:8000.
While offline, you can still analyse everything as you would normally.
-To run in online mode, run node index.js from the project root, and connect to localhost:3000.
+To run in online mode, after running npm install for the first time, run npm start from the project root, and connect to localhost:3000.
In online mode, active filters are broadcast to other users, similar to multiplayer notepad or etherpad.
Currently, all changes are applied from everyone in online mode.
This can be inconvenient, and should be changed in the near future.