Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 130 lines (79 sloc) 5.09 kB
7dc46f5 @alexgraul rough readme work
alexgraul authored
1 # Dataset.js
8d65143 @iros added new readme outline
iros authored
2
bddae45 @tbranyen cleaned up readme
tbranyen authored
3 Dataset is a JavaScript library that makes managing the data behind client-side visualisations easy, including realtime data. It takes care of the loading, parsing, sorting, filtering and querying of datasets as well as the creation of derivative datasets.
8d65143 @iros added new readme outline
iros authored
4
0795844 @iros better readme
iros authored
5 Dataset is part of the [Miso Toolkit](http://misoproject.com).
6f2914f @iros Updating readme with links to dataset site.
iros authored
6 Read more about Dataset [here](http://misoproject.com/dataset)
e85a54a @iros adding a bunch of things to the readme.
iros authored
7
8 ## Download
9
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
10 All downloads are located in the [/dist](https://github.com/misoproject/dataset/tree/master/dist) directory. Here are some of them:
11
9125d42 @tbranyen dependancies=>dependencies
tbranyen authored
12 ### Including Dependencies
e85a54a @iros adding a bunch of things to the readme.
iros authored
13
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
14
a5f1e99 @iros merge fix
iros authored
15 [miso.ds.dev.0.4.1.zip](https://github.com/downloads/misoproject/dataset/miso.ds.dev.0.4.1.zip) - Download Development With Dependencies - 0.4.1
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
16
68c3546 @iros 0.4.1 - Fixing require.js
iros authored
17 [miso.ds.deps.ie.0.4.1.js](https://github.com/downloads/misoproject/dataset/miso.ds.deps.ie.0.4.1.js) - Download Development With Dependencies for IE - 0.4.1
e85a54a @iros adding a bunch of things to the readme.
iros authored
18
68c3546 @iros 0.4.1 - Fixing require.js
iros authored
19 [miso.ds.deps.ie.min.0.4.1.js](https://github.com/downloads/misoproject/dataset/miso.ds.deps.ie.0.4.1.js) - Download Production With Dependencies for IE - 0.4.1
e85a54a @iros adding a bunch of things to the readme.
iros authored
20
9125d42 @tbranyen dependancies=>dependencies
tbranyen authored
21 ### Without Dependencies
e85a54a @iros adding a bunch of things to the readme.
iros authored
22
bddae45 @tbranyen cleaned up readme
tbranyen authored
23 The following builds do not have any of the dependencies built in. It is your own responsibility to include them as appropriate script elements in your page.
e85a54a @iros adding a bunch of things to the readme.
iros authored
24
68c3546 @iros 0.4.1 - Fixing require.js
iros authored
25 [miso.ds.0.4.1.js](https://github.com/downloads/misoproject/dataset/miso.ds.0.4.1.js) - Download Development No Dependencies - 0.4.1
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
26
68c3546 @iros 0.4.1 - Fixing require.js
iros authored
27 [miso.ds.min.0.4.1.js](https://github.com/misoproject/dataset/tree/master/dist/miso.ds.min.0.4.1.js) - Download Production No Dependencies - 0.4.1
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
28
68c3546 @iros 0.4.1 - Fixing require.js
iros authored
29 [miso.ds.0.4.1.m.js](https://github.com/misoproject/dataset/tree/master/dist/miso.ds.0.4.1.m.js) - Download AMD Compatibile Build No Dependencies- 0.4.1
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
30
68c3546 @iros 0.4.1 - Fixing require.js
iros authored
31 [miso.ds.min.0.4.1.m.js](https://github.com/misoproject/dataset/tree/master/dist/miso.ds.min.0.4.1.m.js) - Download AMD Compatibile Build Production No Dependencies- 0.4.1
e85a54a @iros adding a bunch of things to the readme.
iros authored
32
33
9125d42 @tbranyen dependancies=>dependencies
tbranyen authored
34 ### Dependencies
e85a54a @iros adding a bunch of things to the readme.
iros authored
35
9125d42 @tbranyen dependancies=>dependencies
tbranyen authored
36 Dataset has the following dependencies:
e85a54a @iros adding a bunch of things to the readme.
iros authored
37
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
38 * [Lodash.js 0.9.0](http://lodash.com/)
e85a54a @iros adding a bunch of things to the readme.
iros authored
39 * [Underscore.math.js (version unknown)](https://github.com/syntagmatic/underscore.math)
0a6bcce @iros Updating Readme to reflect version bump and dependency updates
iros authored
40 * [Underscore.deferred.js 0.2.0](https://github.com/wookiehangover/underscore.Deferred)
41 * [moment.js 1.7.2](http://momentjs.com/) (for date and time parsing)
9da4124 @iros Version 0.4 release
iros authored
42 * [miso.events.js 0.0.1](http://github.com/misoproject/events) (For adding event behavior)
e85a54a @iros adding a bunch of things to the readme.
iros authored
43
a1b7852 @iros Release 0.2
iros authored
44 If you are planning on supporting IE, include the following json2.js library as well:
45 * [json2.js 2011-10-19](https://github.com/douglascrockford/JSON-js)
46
47
ff60933 @iros better readme
iros authored
48 ## Documentation
748989d @alexgraul Update README.md
alexgraul authored
49
ff60933 @iros better readme
iros authored
50 The full documentation set can be found here:
d6e1bb7 @iros Made all urls clickable + some copy.
iros authored
51 [http://misoproject.com/dataset/docs.html](http://misoproject.com/dataset/docs.html)
f880265 @iros renaming map back to transform on columns. Updating README with our l…
iros authored
52
d6e1bb7 @iros Made all urls clickable + some copy.
iros authored
53 Miso.Dataset works in the browser and in Node.js.
54
fe24ea3 @iros Version 0.2.2 release
iros authored
55 ### Have an intersting issue or question?
56
57 Maybe others have as well. Ask your quesiton as a ticket
58 or check out the current listing of tips and tricks in our
59 [How do I...](https://github.com/misoproject/dataset/wiki/How-Do-I...)
60 wiki page.
61
d6e1bb7 @iros Made all urls clickable + some copy.
iros authored
62 #### Browser support
63
64 Include the appropriate libs as script tags in your web pages
65
66 #### Node Support
67
68 You can require it like so:
53e5eb8 @iros Added contribution info
iros authored
69
ddef631 @tbranyen reordered node example
tbranyen authored
70 ```javascript
71 var Miso = require("miso.dataset");
72 var ds = new Miso.Dataset...
73 ```
53e5eb8 @iros Added contribution info
iros authored
74
ff60933 @iros better readme
iros authored
75 ### API
ae195ee @iros added a few notes based on browsing through dojo's code. Didn't parti…
iros authored
76
ff60933 @iros better readme
iros authored
77 For a detailed API listing, see here:
d6e1bb7 @iros Made all urls clickable + some copy.
iros authored
78 [http://misoproject.com/dataset/api.html](http://misoproject.com/dataset/api.html)
748989d @alexgraul Update README.md
alexgraul authored
79
ff60933 @iros better readme
iros authored
80 ### Examples
f880265 @iros renaming map back to transform on columns. Updating README with our l…
iros authored
81
ff60933 @iros better readme
iros authored
82 For some more complex examples, see the following page:
d6e1bb7 @iros Made all urls clickable + some copy.
iros authored
83 [http://misoproject.com/dataset/examples.html](http://misoproject.com/dataset/examples.html)
f880265 @iros renaming map back to transform on columns. Updating README with our l…
iros authored
84
53e5eb8 @iros Added contribution info
iros authored
85 ## Contributing
86
87 We welcome pull requests! Some things to keep in mind:
88
07190d0 @makoto Modified changeme
makoto authored
89 ### Set up
90
91 Assuming that Ruby is already installed on your machine, you need to install bundler gem to install other required gems so that you can run the test server.
92
93 $ cd test
94 $ gem install bundler
95
96 Once bundler is installed, run ``bundle install`` which install required gems (mostly sinatra)
97
98 $ bundle install
99 Fetching source index for http://rubygems.org/
100 Using rack (1.4.1)
101 Installing rack-contrib (1.1.0)
102 Using rack-protection (1.2.0)
103 Using tilt (1.3.3)
104 Using sinatra (1.3.2)
105 Using bundler (1.0.21)
106
107 Once all the required gems are installed, run the following command
108
109 $ rackup
110 >>> Serving: ~/dataset/test/../
111 >> Thin web server (v1.3.1 codename Triple Espresso)
112 >> Maximum connections set to 1024
113 >> Listening on 0.0.0.0:9292, CTRL+C to stop
114
115 Open the test page on the browser
116
117 open http://localhost:9292/test/index.html
118
119 ### Guideline
53e5eb8 @iros Added contribution info
iros authored
120
121 * Any new functionality must have tests and ensure all current tests still pass. All tests are located in the ```test/unit``` directory.
1399b51 @iros added grunt version details
iros authored
122 * We use cowboy's grunt library to build all our final dependencies. You will need to install grunt per the instructions here: [http://gruntjs.com/](http://gruntjs.com/). Dataset uses grunt 0.4.
53e5eb8 @iros Added contribution info
iros authored
123
ff60933 @iros better readme
iros authored
124 ## Contact
f880265 @iros renaming map back to transform on columns. Updating README with our l…
iros authored
125
d6e1bb7 @iros Made all urls clickable + some copy.
iros authored
126 * For announcements follow @themisoproject on twitter.
bddae45 @tbranyen cleaned up readme
tbranyen authored
127 * Opening issues here is a great way to let us know when something is broken!
6f2914f @iros Updating readme with links to dataset site.
iros authored
128 * If you want to chat with us, join #misoproject on irc (freenode).
129 * Feel free to ping Irene Ros([@ireneros](http://twitter.com/ireneros) on twitter, @iros on github) or Alex Graul ([@alexgraul](http://twitter.com/alexgraul) on both.)
Something went wrong with that request. Please try again.