Skip to content

Commit 5a8bc4f

Browse files
committed
Merge pull request #550 from ColinEberhardt/ColinEberhardt-readme-update
Updated readme
2 parents c920f12 + 89d50de commit 5a8bc4f

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

README.md

+16-13
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
11
# StockFlux
22

3-
StockFlux is an implementation of a desktop app using Openfin, written using [AngularJS](https://angularjs.org/). It pulls data from [Quandl](https://www.quandl.com/), and displays it using [BitFlux](http://scottlogic.github.io/BitFlux/). You can search for new stocks, add stocks to favourites, and tear out stocks (similar to browser tabs). You can also collapse the window into a compact view.
3+
StockFlux is a desktop application developed by [Scott Logic](http://www.scottlogic.com/) that uses the OpenFin HTML5 container.
44

5-
![Image of StockFlux](https://cloud.githubusercontent.com/assets/7962948/13354652/5a48e678-dc94-11e5-9e29-51a076cd3b28.PNG)
5+
![Image of StockFlux](https://cloud.githubusercontent.com/assets/1098110/13568013/a02e0fc8-e456-11e5-9543-4642a54c3e2a.png)
6+
7+
Here are a few things to try:
8+
- Add and remove stocks via the search pane
9+
- Drag tiles within the favourites pane to re-order them
10+
- Drag a tile outside of the favourites pane to create a new application window
11+
- Re-open recent windows via the icon at the bottom right of the favourites pane
12+
- Use the icon on the top right of the title bar to toggle 'collapsed' mode
613

714
## Installing
815

9-
You can download StockFlux from [here](http://scottlogic.github.io/StockFlux/StockFlux.zip). If you haven't already installed an OpenFin application, this will install the OpenFin runtime. It'll also add shortcuts to StockFlux to your desktop and start menu.
16+
In order to install the application, download [StockFlux installer zipfile](http://scottlogic.github.io/StockFlux/StockFlux.zip), unzip and run the executable. If you haven't already installed an OpenFin application, this will install the required runtime. It'll also add shortcuts to StockFlux to your desktop and start menu.
1017

11-
Each application start up, it downloads the application from Github Pages, meaning that it will automatically update and that it cannot be used offline.
18+
This is an 'evergreen' application, each time it launches the application code is downloaded (from GitHub pages), ensuring that it is always up-to-date.
1219

13-
## Developing
20+
# Development
1421

15-
[npm](https://www.npmjs.com/), the package manager for [Node.js](https://nodejs.org/), is used to manage the project's dependencies. [Grunt](http://gruntjs.com/), a JavaScript task runner, is used to test and build the project.
22+
The application is built using AngularJS and ES2016, transpiled via Babel. The charts are rendered using [d3fc](https://d3fc.io/), a Scott Logic open source project which provides a number of components that allow the creation of bespoke interactive charts. The bulk of the charting code is adapted from [BitFlux](http://scottlogic.github.io/BitFlux/), which showcases the capabilities of d3fc.
1623

1724
### Initial Setup
1825

26+
[npm](https://www.npmjs.com/), the package manager for [Node.js](https://nodejs.org/), is used to manage the project's dependencies. [Grunt](http://gruntjs.com/), a JavaScript task runner, is used to test and build the project.
27+
1928
- Download or clone this repository locally
2029
- Ensure [Node.js](https://nodejs.org/), which includes npm, is installed
2130
- Ensure [Grunt](http://gruntjs.com/getting-started#installing-the-cli) is installed:
@@ -30,15 +39,9 @@ npm install -g grunt-cli
3039
npm install
3140
```
3241

33-
- Perform an initial build:
34-
35-
```
36-
grunt build
37-
```
38-
3942
#### Running locally
4043

41-
To run in an OpenFin shell run the grunt task
44+
To run in an OpenFin shell run the `serve` grunt task:
4245

4346
```
4447
grunt serve

0 commit comments

Comments
 (0)