Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 1.55 KB

README.md

File metadata and controls

75 lines (48 loc) · 1.55 KB

Client Library for the Dropbox API

This is a JavaScript client for the Dropbox API, suitable for use in both modern browsers and in server-side code running under node.js.

Supported Platforms

This library is tested against the following JavaScript platforms

  • node.js 0.8
  • Chrome 20
  • Firefox 12
  • Internet Explorer 8, 9, 10

Installation

The library can be included in client-side applications using the following HTML snippet.

<script type="text/javascript" src="http://TODO">
</script>

The library is also available as an npm package, and can be installed using the following command.

npm install dropbox-4real

Usage

TBD

Development

The library is written using CoffeeScript, packaged using uglify.js, and tested using mocha.

Running the Tests

First install node.js to get npm (the node package manager), then use it to install the libraries required by the test suite. Last, use cake to get a Dropbox token that will be used by tests.

git clone https://github.com/pwnall/dropbox-sdk.git
cd dropbox-sdk
npm install -g coffee-script mocha uglify-js
npm install
cake token

After the one-time setup is completed, you can run the node.js tests and/or the browser tests.

cake test
cake webtest

Copyright and License

The library is (c) Copyright Dropbox, Inc. 2012, and distributed under the MIT License.