Skip to content

Commit 5144cdd

Browse files
m0shem0she
committed
update documentation
1 parent 87b3bb2 commit 5144cdd

File tree

4 files changed

+38
-16
lines changed

4 files changed

+38
-16
lines changed

‎.htaccess‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
<Files ~ "\.(md|json|dist)$">
1+
<Files ~ "\.(json|dist)$">
22
deny from all
33
</Files>

‎README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Cloudinary
33

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

6-
Easily upload images to the cloud. Automatically perform smart image resizing, cropping and conversion without installing any complex software. Integrate Facebook or Twitter profile image extraction in a snap, in any dimension and style to match your website’s graphics requirements. Images are seamlessly delivered through a fast CDN, and much much more.
6+
Easily upload images to the cloud. Automatically perform smart image resizing, cropping and conversion without installing any complex software. Integrate Facebook or Twitter profile image extraction in a snap, in any dimension and style to match your website's graphics requirements. Images are seamlessly delivered through a fast CDN, and much much more.
77

88
Cloudinary offers comprehensive APIs and administration capabilities and is easy to integrate with any web application, existing or new.
99

@@ -55,6 +55,8 @@ Generating a 120x90 thumbnail based on automatic face detection of the Facebook
5555

5656
For more details, see our documentation for embedding [Facebook](http://cloudinary.com/documentation/facebook_profile_pictures) and [Twitter](http://cloudinary.com/documentation/twitter_profile_pictures) profile pictures.
5757

58+
### Samples
59+
You can find our simple and ready-to-use samples projects, along with documentations in the [samples folder](https://github.com/cloudinary/cloudinary_php/tree/master/samples). Please consult with the [README file](https://github.com/cloudinary/cloudinary_php/blob/master/samples/README.md), for usage and explanations.
5860

5961
## Usage
6062

@@ -109,7 +111,7 @@ You can also specify your own public ID:
109111

110112
http://res.cloudinary.com/demo/image/upload/sample_remote.jpg
111113
112-
### cl_image_tag
114+
### cl\_image\_tag
113115

114116
Returns an html image tag pointing to Cloudinary.
115117

@@ -119,7 +121,7 @@ Usage:
119121

120122
# <img src='http://res.cloudinary.com/cloud_name/image/upload/c_fill,h_100,w_100/sample.png' height='100' width='100'/>
121123

122-
### cl_form_tag
124+
### cl\_form\_tag
123125

124126
The following function returns an html form that can be used to upload the file directly to Cloudinary. The result is a redirect to the supplied callback_url.
125127

‎samples/PhotoAlbum/upload.php‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@
1818
</head>
1919
<body>
2020
<div id="logo">
21-
<!-- This will render the fetched image using cloudinary -->
22-
<?php echo fetch_image_tag("http://cloudinary.com/images/logo.png") ?>
21+
<!-- This will render the fetched image using cloudinary -->
22+
<?php echo fetch_image_tag("http://cloudinary.com/images/logo.png") ?>
2323
</div>
2424
<div id="posterframe" style="position: absolute; right: 0; top: 5px;">
25-
<!-- This will render the fetched facebook image using cloudinary with all the
26-
requested transformations -->
27-
<?php echo facebook_profile_image_tag("officialchucknorrispage", array(
28-
"format" => "png",
29-
"transformation" => array(
30-
array("height" => 95, "width" => 95, "crop" => "thumb", "gravity" => "face",
31-
"effect" => "sepia", "radius" => 20
32-
), array("angle" => 10)
33-
)));
34-
?>
25+
<!-- This will render the fetched facebook image using cloudinary with all the
26+
requested transformations -->
27+
<?php echo facebook_profile_image_tag("officialchucknorrispage", array(
28+
"format" => "png",
29+
"transformation" => array(
30+
array("height" => 95, "width" => 95, "crop" => "thumb", "gravity" => "face",
31+
"effect" => "sepia", "radius" => 20
32+
), array("angle" => 10)
33+
)));
34+
?>
3535
</div>
3636

3737
<!-- This is the backend upload - based on the fileupload javascript for the frontend and also

‎samples/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Cloudinary PHP samples
2+
======================
3+
4+
Included in this folder are two sample projects intended to demonstrate the flow of the Cloudinary (PHP) usage.
5+
6+
7+
## Installation
8+
The cloudinary\_php package is ready to be served as-is in your Apache server. (Other servers are also supported, but the access restrictions set in .htaccess will probably not work).
9+
10+
11+
## Basic sample
12+
This sample is a synchronous script that shows the upload process from local file, remote URL, with different transformations and options.
13+
14+
You can access it through http://<yourserver>/<path-to-cloudinary_php>/samples/basic/basic.php
15+
16+
## Photo Album
17+
A simple web application that allows you to uploads photos, maintain a database with references to them, list them with their metadata, and display them using various transformations
18+
19+
You can access it through http://<yourserver>/<path-to-cloudinary_php>/samples/PhotoAlbum/list.php
20+

0 commit comments

Comments
 (0)