Skip to content

Commit 3e7d130

Browse files
authored
Add transformation builder sdk reference docs (#540)
1 parent d2f341f commit 3e7d130

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,15 @@ This SDK can also be used with [popular frontend frameworks](https://cloudinary.
1111
This Readme provides basic installation and usage information.
1212
For the complete documentation, see the [URL-Gen SDK Guide](https://cloudinary.com/documentation/javascript_integration) and the [URL-Gen Reference](https://cloudinary.com/documentation/sdks/js/url-gen/index.html).
1313

14+
NOTE: When using the url-gen library, an additional transformation-builder-sdk library is installed as a dependency.
15+
This library handles the transformation generation part of the URL and as such, all transformation actions are imported from this library.
16+
Therefore, you can import all transformations either from @cloudinary/url-gen (as demonstrated in the documentation), or directly from the transformation-builder-sdk library, for example:
17+
```javascript
18+
import {scale} from '@cloudinary/transformation-builder-sdk/actions/resize';
19+
```
20+
21+
You can find all available transformations in the [Transformation Builder reference](https://cloudinary.com/documentation/sdks/js/transformation-builder/index.html).
22+
1423

1524
## Table of Contents
1625
- [Key Features](#key-features)

jsdoc.config.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
"templates": {
1818
"cleverLinks": true,
1919
"navMembers" : [
20-
{"kind": "namespace", "title": "Actions & Qualifiers", "summary": "All documented namespaces."},
2120
{"kind": "interface", "title": "Interfaces", "summary": "All documented interfaces."},
2221
{"kind": "tutorial", "title": "Help & Examples", "summary": "All available tutorials."}
2322
],

0 commit comments

Comments
 (0)