Skip to content

Commit 6efb6f1

Browse files
authored
Standardized readme.md
1 parent ea96744 commit 6efb6f1

1 file changed

Lines changed: 63 additions & 20 deletions

File tree

README.md

Lines changed: 63 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,63 @@
1-
# GroupDocs.Viewer Cloud SDK for PHP
2-
This repository contains GroupDocs.Viewer Cloud SDK for PHP source code. This SDK allows you to work with GroupDocs.Viewer Cloud REST APIs in your PHP applications.
1+
![](https://img.shields.io/badge/api-v2.0-lightgrey) ![Packagist Version](https://img.shields.io/packagist/v/groupdocscloud/groupdocs-viewer-cloud) ![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/groupdocscloud/groupdocs-viewer-cloud) [![GitHub license](https://img.shields.io/github/license/groupdocs-viewer-cloud/groupdocs-viewer-cloud-php)](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-php/blob/master/LICENSE)
32

4-
## Dependencies
5-
- PHP 5.5 or later
3+
# PHP SDK to View Documents in the Cloud
64

7-
## Authorization
8-
To use SDK you need AppSID and AppKey authorization keys. You can get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required).
5+
[GroupDocs.Viewer Cloud SDK for PHP](https://products.groupdocs.cloud/viewer/php) wraps GroupDocs.Viewer RESTful APIs so you may integrate Document Viewing features in your own apps with zero initial cost.
96

10-
## Installation & Usage
11-
### Composer
7+
GroupDocs.Viewer REST API allows the developers to view & render a number of files formats including Word documents, Excel spreadsheets, PowerPoint presentations, PDF, OpenDocument formats, emails, CAD files & images.
8+
9+
## Document Viewer Services in REST
10+
11+
- 90+ supported file formats.
12+
- View documents as PDF, HTML or images.
13+
- Render documents as raster & vector images.
14+
- Render documents with comments & notes.
15+
- Flip or rotate documents pages at 90, 180 or 270 degrees.
16+
- Reorder document pages.
17+
- Render hidden, consecutive or selected document pages.
18+
- Watermark PDF, image or HTML output pages.
19+
- Render with custom fonts as well as replace any missing fonts.
20+
- Load password-protected documents.
21+
- Extract attachment information such as attachment count & names.
22+
- Extract document information like file format, page count, size and visibility, text coordinates, and so on.
23+
- Integrated storage API.
24+
25+
Check out the [Developer's Guide](https://docs.groupdocs.cloud/viewer/developer-guide/) to know more about GroupDocs.Viewer REST API.
26+
27+
## Microsoft File Formats
28+
29+
**Microsoft Word:** DOC, DOCM, DOCX, DOT, DOTM, DOTX\
30+
**Microsoft Excel:** XLS, XLSX, XLSB, XLSM\
31+
**Microsoft PowerPoint:** PPTX, PPTM, PPT, PPSX, PPSM, PPS, POTX, POTM\
32+
**Microsoft Project:** MPP, MPT\
33+
**Microsoft Outlook:** MSG, OST, PST\
34+
**Microsoft Visio:** VDW, VDX, VSD, VSDM, VSDX, VSS, VSSM, VSSX, VST, VSTM, VSTX, VSX, VTX\
35+
**Microsoft OneNote:** ONE
36+
37+
## Other Formats
38+
39+
**Page Layout Formats:** PDF, XPS, TEX\
40+
**OpenDocument:** ODT, OTT, ODS, OTS, ODP, OTP\
41+
**CAD:** DNG, DWF, DWG, DXF, IDC, STL\
42+
**Images:** BMP, CGM, DCM, DJVU, EMP, EPS, GIF, ICO, JP2, JPG, ODG, PCL, PNG, PS, PSD, SVG, TIFF, WEBP, WMF\
43+
**Web:** HTML, MHT, MHTML\
44+
**Emails:** EML, EMLX\
45+
**eBooks:** EPUB, MOBI\
46+
**Others:** TXT, RTF, CSV, TSV
47+
48+
## Get Started with GroupDocs.Viewer Cloud SDK for PHP
49+
50+
First create an account at [GroupDocs for Cloud](https://dashboard.groupdocs.cloud/) and get your application information. Next, follow the steps as given below.
51+
52+
### Installation via Composer
53+
54+
The package is available at [Packagist](https://packagist.org/) and can be installed via [Composer](http://getcomposer.org/) by executing the following command.
1255

13-
The package is available at [Packagist](https://packagist.org/) and it can be installed via [Composer](http://getcomposer.org/) by executing following command:
1456
```
1557
composer require groupdocscloud/groupdocs-viewer-cloud
1658
```
1759

18-
Or you can install SDK via [Composer](http://getcomposer.org/) directly from this repository, add the following to `composer.json`:
60+
You can also install the package directly from this repository. Add the following to `composer.json`, then run `composer install`.
1961

2062
```
2163
{
@@ -31,27 +73,24 @@ Or you can install SDK via [Composer](http://getcomposer.org/) directly from thi
3173
}
3274
```
3375

34-
Then run `composer install`
35-
3676
### Manual Installation
3777

38-
Clone or download this repository, then run `composer install` in the root directory to install dependencies and include `autoload.php` into your code file:
78+
Clone or download this repository, then run `composer install` in the root directory to install dependencies and include `autoload.php` into your code file.
3979

4080
```php
4181
require_once('/path/to/groupdocs-viewer-cloud-php/vendor/autoload.php');
4282
```
4383

44-
## Tests
84+
### Tests
4585

46-
To run the unit tests set your AppSID and AppKey in [json.config](tests/GroupDocs/Viewer/config.json) and execute following commands:
86+
Set your application information in [json.config](tests/GroupDocs/Viewer/config.json), and execute the following to run the tests.
4787

4888
```
4989
php composer.phar install
5090
./vendor/bin/phpunit
5191
```
5292

53-
## Getting Started
54-
Please follow the [installation procedure](#installation--usage) and then run the following:
93+
## Get a List of Viewable File Formats
5594

5695
```php
5796
<?php
@@ -79,7 +118,11 @@ try {
79118
?>
80119
```
81120

82-
## Licensing
83-
GroupDocs.Viewer Cloud SDK for PHP is licensed under [MIT License](LICENSE).
121+
## GroupDocs.Viewer Cloud SDKs in Popular Languages
122+
123+
| .NET | Java | PHP | Python | Ruby | Node.js | Android |
124+
|---|---|---|---|---|---|---|
125+
| [GitHub](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-dotnet) | [GitHub](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-java) | [GitHub](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-php) | [GitHub](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-python) | [GitHub](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-ruby) | [GitHub](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-node) | [GitHub](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-android) |
126+
| [NuGet](https://www.nuget.org/packages/GroupDocs.Viewer-Cloud/) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-viewer-cloud) | [Composer](https://packagist.org/packages/groupdocscloud/groupdocs-viewer-cloud) | [PIP](https://pypi.org/project/groupdocs-viewer-cloud/) | [GEM](https://rubygems.org/gems/groupdocs_viewer_cloud) | [NPM](https://www.npmjs.com/package/groupdocs-viewer-cloud) | [Maven](https://repository.groupdocs.cloud/webapp/#/artifacts/browse/tree/General/repo/com/groupdocs/groupdocs-viewer-cloud-android) |
84127

85-
[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/viewer/php) | [Docs](https://docs.groupdocs.cloud/viewer/) | [Demos](https://products.groupdocs.app/viewer/family) | [API Reference](https://apireference.groupdocs.cloud/viewer/) | [Examples](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-php-samples) | [Blog](https://blog.groupdocs.cloud/category/viewer/) | [Free Support](https://forum.groupdocs.cloud/c/viewer) | [Free Trial](https://purchase.groupdocs.cloud/trial)
128+
[Home](https://www.groupdocs.cloud/) | [Product Page](https://products.groupdocs.cloud/viewer/php) | [Documentation](https://docs.groupdocs.cloud/viewer/) | [Live Demo](https://products.groupdocs.app/viewer/total) | [API Reference](https://apireference.groupdocs.cloud/viewer/) | [Code Samples](https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-php-samples) | [Blog](https://blog.groupdocs.cloud/category/viewer/) | [Free Support](https://forum.groupdocs.cloud/c/viewer) | [Free Trial](https://dashboard.groupdocs.cloud)

0 commit comments

Comments
 (0)