ruby_slides 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e578fb2796af5721b2dac0f714008dc2931251a6
-  data.tar.gz: 724e2a43e2290b97be58b812f56dd39d0d11f658
+  metadata.gz: e55eeb9eaa2c8bd93033fa06ca008876cc48a7bc
+  data.tar.gz: 6d8aa9e0f1bcb2e0797c4799279e5763bb3fee01
 SHA512:
-  metadata.gz: f179ad0ea0e90b7b17e90012316a34f059ed9bbf2037382229ff3a1bc0775451dcc4deed0cdcbbc0d784e49017be45fe10dc6cba140c6337bce693185bc7498e
-  data.tar.gz: edaa7a60d5bdaecc708a884bb3d3d2f6bafa1ef20bfc1ac45ddd7f10408c31d1b1420e6901e2933c76cef62aadf6cadff70abe42366512294753e367c5ed4ea8
+  metadata.gz: ed967f2d96a49f90eeea33915b60d110d2623a083202c5d6a52f3a825a98528b16774ca2e7ad70137180bf78bb5b719c693c6c08167ef240aedc8006648673fd
+  data.tar.gz: 36ab0738453f95a30243b0d61b36fa30cadef1d5744fe5e683b408696744e1624bbf4b0f2fe0fbd807860e8409e5453a3057c73825ed4d83e7ae9222889c8484

data/README.md

@@ -24,9 +24,107 @@ Optionally use the latest code using:
 gem 'ruby_slides', git: "https://github.com/danielsousaio/ruby_slides.git"
 ```
 
-## Usage
+## Getting started
 
 
+Get started by creating a new object
+
+```ruby
+@presentation =  RubySlides::Presentation.new
+```
+
+RubySlides offer various types of slide as described below. If you would like
+to see an example of a powerpoint generated with RubySlides take a look at the
+powerpoint in the example folder. That's the result of running the spec.
+
+
+### Introduction Slide
+
+```ruby
+title = "Hello Universe!"
+subtitle = "Powerpoints with ruby"
+@presentation.introduction_slide title, subtitle
+```
+
+### Textual Slide
+
+```ruby
+textual_title = "Textual Slide"
+textual_items = ["Item 1", "Item 2", "Item 3"]
+@presentation.textual_slide textual_title, textual_items
+```
+
+### Pictorial Slide
+
+```ruby
+pictorial_title = "Image Slide"
+picture_path = "example/ruby.png"
+@presentation.pictorial_slide pictorial_title, picture_path
+```
+
+### Pictorial with coordinates
+
+```ruby
+picture_coords = { x: 550 * 12700, y: 30 * 12700,     # Picture Position
+                  cx: 80 * 12700, cy: 60 * 12700 }    # Picture Sizing
+@presentation.pictorial_slide pictorial_title, picture_path, picture_coords
+```
+
+### Text Picture Slide
+
+```ruby
+text_picture_title = "Text Picture Slide"
+text_picture_content = [
+    "Picture size: 2MB", 
+    "Picture author: Unknown Rubyist"
+  ]
+@presentation.text_picture_slide text_picture_title, picture_path,
+                                 text_picture_content
+```
+
+### Picture Description Slide
+
+```ruby
+picture_description_title = "Picture Description Slide"
+picture_description_content = [
+    "Picture description, long text",
+    "Additional information"
+  ]
+@presentation.picture_description_slide picture_description_title,
+                                    picture_path,
+                                    picture_description_content
+```
+
+### Table Slide
+
+```ruby
+table_title = "Table Slide"
+table_series = [
+  ["HeaderA", "HeaderB"],
+  ["ValueA", "ValueB"]
+]
+@presentation.table_slide table_title, table_series
+```
+
+### Chart Slide
+
+```ruby
+chart_title = "Chart Slide"
+chart_series = [
+    {
+      column: "Col1",
+      rows:   ["A", "B", "C", "D"],
+      values: ["1", "3", "5", "7"]
+    },
+    {
+      column: "Col2",
+      rows:   ["A", "B", "C", "D"],
+      values: ["2", "4", "6", "8"]
+    }
+  ]
+@presentation.chart_slide chart_title, chart_series
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ruby_slides/version.rb

@@ -1,3 +1,3 @@
 module RubySlides
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/ruby_slides.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mail@danielsousa.io"]
 
   spec.summary       = "RubySlides"
-  spec.description   = "Create Powerpoint presentations in Ruby with elements like slides, text, images, tables and charts."
+  spec.description   = "Create Powerpoint presentations in Ruby with tables, images and charts."
   spec.homepage      = "https://github.com/danielsousaio/ruby_slides"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_slides
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Daniel Sousa
@@ -80,8 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-description: Create Powerpoint presentations in Ruby with elements like slides, text,
-  images, tables and charts.
+description: Create Powerpoint presentations in Ruby with tables, images and charts.
 email:
 - mail@danielsousa.io
 executables: []