diff --git a/.npmignore b/.npmignore new file mode 100644 index 00000000..1ce5400d --- /dev/null +++ b/.npmignore @@ -0,0 +1,3 @@ +example +examples +build/.module-cache diff --git a/README.md b/README.md index 67278374..734849b1 100644 --- a/README.md +++ b/README.md @@ -3,34 +3,31 @@ matrix-react-sdk This is a react-based SDK for inserting a Matrix chat client into a web page -Getting started with the example -================================ +Getting started with the trivial example +======================================== 1. Install or update `node.js` so that your `npm` is at least at version `2.0.0` 2. Clone the repo: `git clone https://github.com/matrix-org/matrix-react-sdk.git` -3. Switch to your new checkout: `cd matrix-react-sdk` -4. Build the CSS: `npm install && npm run build:css` -5. Switch to the example: `cd example` -6. Build the javascript & copy the CSS: - `npm install && npm run build && ln -s ../bundle.css ./` +3. Switch to the example directory: `cd matrix-react-sdk/examples/trivial` +4. Install the prerequisites: `npm install` +5. Build the example and start a server: `npm start` -Serve the app from within the `example` directory by running `python -m -SimpleHTTPServer 8000` and access it at -[http://127.0.0.1:8000](http://127.0.0.1:8000/) +Now open http://127.0.0.1:8080/ in your browser to see your newly built +Matrix client. Using the example app for development ===================================== -To develop using the example app, you can avoid havign to repeat the above -steps each time you change something: +The above commands will let you start working on the app, and any changes you +make to the javascript source files will cause the javascript to be rebuilt +automatically, but the same will not apply for the CSS. -1. Perform all the steps above -2. In the matrix-react-sdk directory: `npm run start:css` -3. Open a new terminal window in the matrix-react-sdk directory: - `cd example; npm start` +To have the CSS bundle also rebuild as you change it: -Now, development version of your Javascript and CSS will be rebuilt whenever -you change any of the files (although you may need to restart the CSS builder -if you add a new file). Note that the debug CSS and Javascript are much, much -larger than the production versions. +1. `cd matrix-react-sdk` +2. `npm start:css` + +Note that you may need to restart the CSS builder if you add a new file. Note +that `npm start` builds debug versions of the the javascript and CSS, which are +much larger than the production versions build by the `npm run build` commands. diff --git a/example/README.md b/examples/trivial/README.md similarity index 100% rename from example/README.md rename to examples/trivial/README.md diff --git a/example/index.html b/examples/trivial/index.html similarity index 79% rename from example/index.html rename to examples/trivial/index.html index bdc7ce7e..98703e27 100644 --- a/example/index.html +++ b/examples/trivial/index.html @@ -7,6 +7,6 @@
- +