PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Mention package script in readme

Browse source
This commit is contained in:
David Baker 2016-02-25 10:47:09 +00:00
parent fa322e8488
commit 642c33e8d9
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -35,9 +35,15 @@ You will need to re-run `npm run build` after editing `config.json`.
Deployment
==========
For production use, run `npm run build` to build all the necessary files
into the `vector` directory. You can then mount the vector directory on
your webserver to actually serve up the app, which is entirely static content.
On a Unix-based OS, run `npm run package` to build a tarball package. Untaring
this file will give a version-specific directory containing all the files that
need to go on your web server.
The package script is not supported on Windows, so Windows users can run `npm
run build`, which will build all the necessary files into the `vector`
directory. Note that the version of Vector will not appear in Settings without
using the package script. You can then mount the vector directory on your
webserver to actually serve up the app, which is entirely static content.
Development
===========