David Baker
db07ef7899
Update readme to point to github releases
...
not /packages
2016-11-02 12:01:01 +00:00
David Baker
f17e851435
Rename the package script/output dir to 'dist'
...
To match conventions from other projects and match the release
script which expects releasde artefacts in dist/
2016-11-01 15:22:06 +00:00
Richard van der Hoff
e0556789d2
readme tweaks
...
Note that Chrome requires https for voip (fixes #2506 )
Remove lies about where issues are filed.
2016-10-25 11:20:23 +01:00
David Baker
9310d92605
document integrations config in README
2016-10-21 14:59:13 +01:00
Richard van der Hoff
d72323bfc5
typo
2016-10-20 17:05:44 +01:00
Richard van der Hoff
dfd0356609
s/vector/riot/ in the readme
...
Also remove the outdated "E2E" section
Fixes https://github.com/vector-im/vector-web/issues/2457
2016-10-20 16:54:30 +01:00
David Baker
562b047362
Typo
2016-10-05 13:49:30 +01:00
David Baker
381c9009fb
Doc roomDirectory config section
2016-10-04 16:21:39 +01:00
Richard van der Hoff
e8a12e7ddc
Revert "fix instructions"
...
This reverts commit 6a13155013
2016-09-16 17:27:52 +01:00
Matthew Hodgson
6a13155013
fix instructions
2016-09-16 17:08:27 +01:00
Matthew Hodgson
0aae88d753
nudge jenkins
2016-08-30 14:40:30 +01:00
Matthew Hodgson
13983900c0
clarify electron instructions
2016-08-27 22:21:52 +01:00
Matthew Hodgson
e06caa9ca1
mention not just a problem for Vector
2016-08-27 00:13:56 +01:00
Matthew Hodgson
efc5462131
warn people to put their Matrix HS on a separate domain
2016-08-27 00:13:20 +01:00
Richard van der Hoff
f2936dc15c
Update encryption info in README
2016-08-23 18:07:07 +01:00
David Baker
678393e2bd
Add note about file table overflows
2016-08-12 09:59:56 +01:00
Matthew Hodgson
d4faacf462
clear up IS ambiguity and close https://github.com/vector-im/vector-web/issues/1720
2016-07-31 23:42:34 +01:00
Matthew Hodgson
fd53f10fbd
improve the getting started instructions and plug the electron apps
2016-07-28 16:05:21 +02:00
Matthew Hodgson
80ad45df06
spell out that vector should not depend on the public net
2016-07-15 15:57:59 +01:00
Matthew Hodgson
fef81748bb
major update to dev guidelines
2016-07-11 18:25:58 +01:00
Richard van der Hoff
bb820bebd1
README: fix some lies
...
Take out a few misleading things from the readme.
2016-06-20 14:36:40 +01:00
David Baker
a373849b5b
Give better instructions for modifying config.
2016-06-15 11:03:52 +01:00
David Baker
a8cee87c08
js-sdk doesn't have a build step
2016-06-14 15:53:13 +01:00
David Baker
a7598ea815
Mention copying sample file here too
2016-06-14 15:52:03 +01:00
David Baker
22cef7a6a0
Copy config.json first
2016-06-14 15:41:55 +01:00
David Baker
b643d8ff6a
Update README.md
...
To reflect the fact that you can now sensibly deploy from a package (ie. be able to configure the app). Make the first thing be downloading a prebuilt package so people who only read the first part don't end up running npm start in production and complain about needing npm.
2016-06-14 15:12:35 +01:00
Richard van der Hoff
da7e9840f3
reinstate npm 3 warning
2016-03-11 15:12:28 +00:00
Richard van der Hoff
cc18458bec
Update README to include npm install in react-sdk
...
Casual users of /develop shouldn't need to do the whole
clone-three-repositories thing.
2016-03-11 15:09:29 +00:00
David Baker
642c33e8d9
Mention package script in readme
2016-02-25 10:47:09 +00:00
David Baker
ef00bc6d56
Manually merge relevant remaining parts of https://github.com/vector-im/vector-web/pull/790 that aren't covered by @richvdh's PR.
2016-02-24 11:59:29 +00:00
David Baker
1ecedd2769
Add back deployment info
2016-02-24 11:48:51 +00:00
David Baker
9c9e260410
Make the README more idiot-proof
2016-02-24 11:36:57 +00:00
Richard van der Hoff
ca89c09e73
formatting
2016-02-23 21:00:27 +00:00
Richard van der Hoff
10f6277de2
Update the README to make the development instructions clearer
2016-02-23 20:55:37 +00:00
David Baker
ab9dfd185c
Add note to not use npm start in production
2016-02-04 18:43:23 +00:00
Richard van der Hoff
f8e5bbef0b
Add a link to E2E bug in the README
2015-12-08 16:03:12 +00:00
Richard van der Hoff
759e35003b
Put some warnings on the crypto stuff
2015-12-04 15:39:39 +00:00
Richard van der Hoff
56b7b65920
Notes on building a crypto-enabled version
2015-12-03 18:25:20 +00:00
Matthew Hodgson
92728ff4e6
spell out npm run build
2015-11-22 01:13:08 +00:00
Matthew Hodgson
731881ee7b
fix language
2015-10-25 12:35:52 +00:00
Matthew Hodgson
47dca51c38
spell out how to set up the deps when developing
2015-10-25 12:33:13 +00:00
Matthew Hodgson
5844fb4020
spell out that developers need to use npm link
2015-10-25 11:56:29 +00:00
Matthew Hodgson
a05437e81f
add npm i source-map-loader troubleshooting step
2015-10-10 18:51:22 +01:00
David Baker
df39c3a281
Changes from PR feedback
2015-10-02 16:44:35 +01:00
David Baker
7b9cd7c232
Update readme
2015-10-01 16:02:44 +01:00
Matthew Hodgson
56c5f6f46e
clarify deployment
2015-09-19 20:17:45 +01:00
Matthew Hodgson
2d1b88e50d
use right paths
2015-07-28 16:30:01 +01:00
David Baker
8c25855f38
Tweak README for vector
2015-07-21 22:45:01 -07:00
Matthew Hodgson
49e687f584
typo
2015-07-12 14:09:53 +01:00
Matthew Hodgson
e3f42dcd5e
more overview
2015-07-08 11:35:40 +01:00
Matthew Hodgson
c346a27e6f
matrix ain't just chat
2015-07-08 11:33:04 +01:00
Matthew Hodgson
ba68810a87
fix english
2015-07-08 11:25:11 +01:00
Matthew Hodgson
b170bc2cb2
clarify skinning semantics
2015-07-08 11:15:25 +01:00
David Baker
6c81a8d46d
Add blurb on how to build a customised app.
2015-07-07 18:27:34 +01:00
Matthew Hodgson
df4c5c588a
define skins
2015-07-07 18:04:31 +01:00
Matthew Hodgson
15c93b61aa
try to write down the various naming & architectural conventions that the SDK adheres to...
2015-07-07 17:46:18 +01:00
David Baker
be9d8f1768
Correct docs again: you do need to npm install the react sdk root explicitly
2015-07-06 18:58:32 +01:00
David Baker
3e87e043d6
Fix docs
2015-07-06 18:29:24 +01:00
David Baker
6c35908949
Add example shwing how to customise, make customising work and document all the ways in which browserify will break and how to work around it being dumb.
2015-07-06 14:13:02 +01:00
David Baker
275286801b
Add npm link to the README
2015-07-03 16:15:23 +01:00
David Baker
3a68748320
Almost
2015-07-03 15:57:35 +01:00
David Baker
dff74f44de
Tweak the example build process. Move example -> examples/trivial to we can have more than one. Update README appropriately.
2015-07-03 15:56:04 +01:00
David Baker
e5a4e5b195
Add more detail to the getting started instructions.
2015-06-24 17:58:13 +01:00
Brennan Novak
76cc258dde
added instructions to README
2015-06-24 17:33:53 +02:00
David Baker
c42733ec95
Basic structure of a react SDK and start of an implementation.
2015-06-09 17:40:42 +01:00
