Doc: Update manual & README.md

Author: ivanlanin

Documentation/PHPPowerPoint Manual.md

@@ -1,6 +1,8 @@
-# PHPPowerPoint
+# PHPPowerPoint Manual
 
-PHPPowerPoint is a library written in pure PHP that provides a set of classes to write to and read from different presentation file formats. PHPPowerPoint is an open source project licensed under LGPL.
+PHPPowerPoint is a library written in pure PHP that provides a set of classes to write to and read from different presentation file formats, i.e. OpenXML (.pptx) and OpenDocument (.odp). PHPPowerPoint is an open source project licensed under LGPL.
+
+## Overview
 
 ### Features
 
@@ -75,21 +77,73 @@ $shape = $slide->createRichTextShape();
 
 Shapes are objects that can be added to a slide. There are five types of shapes that can be used, i.e. rich text, line, chart, drawing, and table.
 
-```php
-$richText = $slide->createRichTextShape();
-$line = $slide->createLineShape();
-```
-
-Below are the methods of slide that can be used to create shapes.
+To create a shape, use the following methods of a slide.
 
 - `createRichTextShape`
 - `createLineShape`
 - `createChartShape`
 - `createDrawingShape`
 - `createTableShape`
 
+Example:
+
+```php
+$richText = $slide->createRichTextShape();
+$line = $slide->createLineShape();
+```
+
+Every shapes have common properties that you can set by using fluent interface.
+
+- `width` in pixels
+- `height` in pixels
+- `offsetX` in pixels
+- `offsetY` in pixels
+- `rotation` in degrees
+- `fill`
+- `border`
+- `shadow`
+- `hyperlink`
+
+Example:
+
+```php
+$richtext = $slide->createRichTextShape()
+    ->setHeight(300)
+    ->setWidth(600)
+    ->setOffsetX(170)
+    ->setOffsetY(180);
+```
+
 #### Rich text
 
+Rich text shapes contain paragraphs of texts. Below are the properties that you can set for a rich text shape.
+
+- `wrap`
+- `autoFit`
+- `horizontalOverflow`
+- `verticalOverflow`
+- `upright`
+- `vertical`
+- `columns`
+- `bottomInset` in pixels
+- `leftInset` in pixels
+- `rightInset` in pixels
+- `topInset` in pixels
+
+Example:
+
+```php
+$richtext = $slide->createRichTextShape()
+    ->setWrap(PHPPowerPoint_Shape_RichText::WRAP_SQUARE)
+    ->setBottomInset(600);
+```
+
+Properties that can be set for each paragraphs are as follow.
+
+- `alignment`
+- `font`
+- `bulletStyle`
+
 #### Line
 
 #### Chart
@@ -100,9 +154,46 @@ Below are the methods of slide that can be used to create shapes.
 
 ### Styles
 
-- Alignment
-- Border
-- Bullet
-- Color
-- Fill
-- Font
+#### Fill
+
+- `fillType`
+- `rotation`
+- `startColor`
+- `endColor`
+
+#### Border
+
+- `lineWidth`
+- `lineStyle`
+- `dashStyle`
+- `color`
+
+#### Alignment
+
+- `horizontal`
+- `vertical`
+- `level`
+- `indent`
+- `marginLeft`
+- `marginRight`
+
+#### Font
+
+- `name`
+- `bold`
+- `italic`
+- `superScript`
+- `subScript`
+- `underline`
+- `strikethrough`
+- `color`
+
+#### Bullet
+
+- `bulletType`
+- `bulletFont`
+- `bulletChar`
+- `bulletNumericStyle`
+- `bulletNumericStartAt`
+
+#### Color

README.md

@@ -1,32 +1,49 @@
-# PHPPowerPoint - OpenXML - Read, Write and Create PowerPoint documents in PHP
+# ![PHPPowerPoint](https://github.com/PHPOffice/PHPPowerPoint/raw/master/Documentation/assets/PHPPowerPointLogo.png "PHPPowerPoint")
 
-Project providing a set of classes for the PHP programming language, which allow you to write to and read from different file formats, like PowerPoint 2007, ... This project is built around Microsoft's OpenXML standard and PHP.
-Checkout the Features this class set provides, such as setting presentation meta data (author, title, description, ...), adding slides, adding images to your presentation and much, much more!
+[![Build Status](https://travis-ci.org/PHPOffice/PHPPowerPoint.svg?branch=master)](https://travis-ci.org/PHPOffice/PHPPowerPoint)
 
-## Want to contribute?
 
-Fork us!
+PHPPowerPoint is a library written in pure PHP that provides a set of classes to write to different presentation file formats, i.e. OpenXML (.pptx) and OpenDocument (.odp). PHPPowerPoint is an open source project licensed under [LGPL](LICENSE.md).
 
-## Requirements
+### Features
+
+- Create an in-memory presentation representation
+- Set presentation meta data (author, title, description, etc)
+- Add slides from scratch or from existing one
+- Supports different fonts and font styles
+- Supports different formatting, styles, fills, gradients
+- Supports hyperlinks and rich-text strings
+- Add images with different styles (positioning, rotation, shadow)
+- Set printing options (header, footer, page margins, paper size, orientation)
+- Output to different file formats: PowerPoint 2007 (.pptx), OpenDocument Presentation (.odp), Serialized Spreadsheet)
+- ... and lots of other things!
+
+### Requirements
 
 The following requirements should be met prior to using PHPPowerPoint:
 
-* PHP version 5.2 or higher
-* PHP extension php_zip enabled
-* PHP extension php_xml enabled
+- PHP version 5.2 or higher
+- PHP extension php_zip enabled
+- PHP extension php_xml enabled
 
-## Installation
+### Installation
 
-Installation is quite easy: copy the contents of the Classes folder to any location
-in your application required.
+To install and use PHPPowerPoint, copy the contents of the `Classes` folder and include `PHPPowerPoint.php` somewhere in your code like below.
 
-Afterwards, make sure you can include all PHPPowerPoint files. This can be achieved by
-respecting a base folder structure, or by setting the PHP include path, for example:
+```php
+include_once '/path/to/Classes/PHPPowerPoint.php';
+```
+
+After that, you can use the library by creating a new instance of the class.
 
 ```php
-set_include_path(get_include_path() . PATH_SEPARATOR . '/path/to/PHPPowerPoint/');
+$phpPowerPoint = new PHPPowerPoint();
 ```
 
-## License
+### Want to learn more?
+
+[Read the manual](Documentation/PHPPowerPoint Manual.md).
+
+### Want to contribute?
 
-PHPPowerPoint is licensed under [LGPL (GNU LESSER GENERAL PUBLIC LICENSE)](LICENSE.md)
+[Fork us on GitHub](https://github.com/PHPOffice/PHPPowerPoint)!