@@ -17,16 +17,16 @@ Usage with Webpack or Browserify
17
17
18
18
Install the package using NPM::
19
19
20
- npm install --save git+http://bitbucket.org/ ftrack/ftrack-javascript- api.git
20
+ npm install --save @ ftrack/api
21
21
22
- You can then import or require the `ftrack-javascript- api ` package::
22
+ You can then import or require the `@ ftrack/ api ` package::
23
23
24
- var ftrack = require('ftrack-javascript- api');
24
+ var ftrack = require('@ ftrack/ api');
25
25
var session = new ftrack.Session(...)
26
26
27
27
Or, using ES2015-style imports::
28
28
29
- import { Session } from 'ftrack-javascript- api';
29
+ import { Session } from '@ ftrack/ api';
30
30
var session = new Session(...);
31
31
32
32
Usage with Node
@@ -35,13 +35,13 @@ Usage with Node
35
35
To use the API with node, you will need to install the a polyfill for the fetch
36
36
API, `isomorphic-fetch <https://github.com/matthew-andrews/isomorphic-fetch >`_::
37
37
38
- npm install --save isomorphic-fetch git+http://bitbucket.org/ ftrack/ftrack-javascript- api.git
38
+ npm install --save isomorphic-fetch @ ftrack/api
39
39
40
- Require `isomorphic-fetch ` to add the polyfill, then require the API and
40
+ Require `isomorphic-fetch ` to add the polyfill, then require the API and
41
41
instantiate a Session.::
42
42
43
43
require('isomorphic-fetch');
44
- var ftrack = require('ftrack-javascript- api');
44
+ var ftrack = require('@ ftrack/ api');
45
45
var session = new ftrack.Session(...)
46
46
47
47
.. note ::
@@ -55,11 +55,9 @@ Building distribution bundle from source
55
55
You can also build manually from the source for more control. First, make sure
56
56
you have node (v5+) installed, see :ref: `installing/node ` for instructions.
57
57
58
- Obtain a copy of the source by either downloading the
59
- `zipball <https://bitbucket.org/ftrack/ftrack-javascript-api/get/master.zip >`_ or
60
- cloning the public repository::
58
+ Obtain a copy of the source by cloning the public repository::
61
59
62
- git clone git@bitbucket.org:ftrack/ftrack- javascript-api.git
60
+ git clone git@github.com:ftrackhq/ javascript-api.git
63
61
64
62
Then you can build the package ::
65
63
@@ -79,7 +77,7 @@ To build the documentation from source::
79
77
80
78
Then view in your browser::
81
79
82
- file:///path/to/ftrack-javascript- api/build/doc/html/index.html
80
+ file:///path/to/@ ftrack/ api/build/doc/html/index.html
83
81
84
82
Dependencies building docs
85
83
--------------------------
0 commit comments