Skip to content

Commit b7fea47

Browse files
author
Lorie Pisicchio
committed
Update README.md
1 parent fc786ea commit b7fea47

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,22 @@
11
# streamdata-js
22
Streamdata Javascript SDK package containing SDK, documentation and sample applications
3+
4+
The SDK will allow you to use <a href="http://streamdata.io">streamdata.io</a> Proxy to get data from various sources, and use them in your application.
5+
In this directory, you will find
6+
- a minified version of the SDK (streamdataio.min.js)
7+
- the documentation that will help you understand how it works
8+
- some sample projects to show you how to use this SDK within a Javascript application, using your favorite JS stack
9+
- stockmarket sample shows how to get data from a demo data source returning simulated market data, and bind them to a simple UI using JQuery
10+
- stockmarket-angular is another version of stockmarket projet using AngularJS
11+
- twitter show how to use Twitter API, and pass a specific OAuth header to streamdata.io proxy
12+
13+
For both sample, after cloning the git repository, you can run
14+
- ```npm install```
15+
- ```bower install```
16+
- ```gulp serve```
17+
18+
to run the sample, and browse the code to understand how it works.
19+
20+
If you have any question of feedback, feel free to ask : <a href="mailto://[email protected]">[email protected]</a>
21+
22+
Enjoy !

0 commit comments

Comments
 (0)