Skip to content
This repository was archived by the owner on Apr 8, 2021. It is now read-only.

Commit 989732e

Browse files
committed
Update README.md
- Add instructions for installation of lodash and jQuery - Add lodash / jQuery `<script>` tag - Clearly state that this is a client library
1 parent caac45f commit 989732e

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
This is a distribution repository for `bower` and `npm`. The sources for this repository are maintained at the [cloudinary_js repository](https://github.com/cloudinary/cloudinary_js). Please submit issues and pull requests to that repository.
1+
:information_source: This is a distribution repository for `bower` and `npm`. The sources for this repository are maintained at the [cloudinary_js repository](https://github.com/cloudinary/cloudinary_js). Please submit issues and pull requests to that repository.
22

3-
# Cloudinary - bower and npm repository
3+
# Cloudinary Client Side JavaScript Library<br>`bower` and `npm` repository
44

55
Cloudinary is a cloud service that offers a solution to a web application's entire image management pipeline.
66

@@ -20,25 +20,29 @@ Cloudinary provides URL and HTTP based APIs that can be easily integrated with a
2020
### bower
2121

2222
1. Install the files using the following command. Use the optional `--save` parameter if you wish to save the dependency in your bower.json file.
23-
24-
```shell
25-
bower install cloudinary-core
26-
```
23+
```shell
24+
bower install cloudinary-core
25+
```
2726
1. Include the javascript file in your HTML. For Example:
2827

29-
```html
30-
<script src="bower_components/cloudinary-core/cloudinary-core.js"></script>
31-
```
28+
```html
29+
<script src="bower_componenets/lodash/lodash.js" type="text/javascript"></script>
30+
<script src="bower_components/cloudinary-core/cloudinary-core.js" type="text/javascript"></script>
31+
```
3232

3333
### NPM
34+
The following instructions describe the installation of the **client-side libraries**. For the server side NodeJS library, see https://github.com/cloudinary/cloudinary_npm
3435

3536
1. Install the files using:
36-
`npm install cloudinary_core`.
37+
```
38+
npm install lodash
39+
npm install cloudinary-core
40+
```
3741
1. Include the javascript file in your HTML. For Example:
38-
39-
```html
40-
<script src="node_modules/cloudinary-core/cloudinary-core.js"></script>
41-
```
42+
```html
43+
<script src="node_modules/lodash/lodash.js" type="text/javascript"></script>
44+
<script src="node_modules/cloudinary-core/cloudinary-core.js" type="text/javascript"></script>
45+
```
4246

4347
For the server side NPM library, please refer to https://github.com/cloudinary/cloudinary_npm.
4448

@@ -64,10 +68,12 @@ http://cloudinary.com/blog/direct_image_uploads_from_the_browser_to_the_cloud_wi
6468
The Cloudinary Documentation can be found at:
6569
http://cloudinary.com/documentation
6670

67-
### Core JavaScript library
71+
### Cloudinary JavaScript library
6872

6973
The Core Cloudinary JavaScript library provides several classes, defined under the "`cloudinary`" domain. The reference documentation is located at https://cloudinary.github.io/pkg-cloudinary-core
7074

75+
The Cloudinary JavaScript library provides several classes, defined under the "`cloudinary`" domain.
76+
7177
#### Configuration
7278

7379
Start by instantiating a new Cloudinary class:

0 commit comments

Comments
 (0)