Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 2.04 KB

README.md

File metadata and controls

63 lines (48 loc) · 2.04 KB
Raw

Dropbox JavaScript SDK Build Status npm version

The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments.

Table of Contents

Documentation

The full documentation can be found here: http://dropbox.github.io/dropbox-sdk-js

Quickstart

Install the SDK using npm:

$ npm install --save dropbox

Use with a module bundler like webpack or browserify:

var Dropbox = require('dropbox');
var dbx = new Dropbox({ accessToken: 'YOUR_ACCESS_TOKEN_HERE' });
dbx.filesListFolder({path: ''})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Examples

See examples/ for working examples of how the SDK can be used in a few different environments.

Versioning

We will try to follow semver as close as possible. That means bug fixes will be patch releases (1.0.1 -> 1.0.2), additional functionality like new endpoints will be minor releases (1.0.1 -> 1.1.0) and breaking changes to both the library and the API endpoints it hits, will be major releases (1.0.1 -> 2.0.0).

This SDK will be taking the dropbox package name on npm from the legacy SDK, that uses the old version of the Dropbox API. This will bump the version number from 0.10.3 to 2.0.0, which should avoid breaking changes due to semver assumptions.

Contributing

Please see CONTRIBUTING.md for information on how to contribute, setup the development environment and run tests.