refactor - convert to recipe (#99)

dynamic · May 9, 2018 · 6964b6e · 6964b6e
1 parent eb8f60a
commit 6964b6e
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 51 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,7 @@
-# SilverStripe Elemental Blocks
+# SilverStripe Elemental Blocks Recipe
 
 Additional elements for the [SilverStripe Elemental](https://github.com/dnadesign/silverstripe-elemental) module.
 
-[![Build Status](https://travis-ci.org/dynamic/silverstripe-elemental-blocks.svg?branch=master)](https://travis-ci.org/dynamic/silverstripe-elemental-blocks)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-blocks/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-blocks/?branch=master)
-[![Code Coverage](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-blocks/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-blocks/?branch=master)
-[![Build Status](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-blocks/badges/build.png?b=master)](https://scrutinizer-ci.com/g/dynamic/silverstripe-elemental-blocks/build-status/master)
-[![codecov](https://codecov.io/gh/dynamic/silverstripe-elemental-blocks/branch/master/graph/badge.svg)](https://codecov.io/gh/dynamic/silverstripe-elemental-blocks)
-
 [![Latest Stable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-blocks/v/stable)](https://packagist.org/packages/dynamic/silverstripe-elemental-blocks)
 [![Total Downloads](https://poser.pugx.org/dynamic/silverstripe-elemental-blocks/downloads)](https://packagist.org/packages/dynamic/silverstripe-elemental-blocks)
 [![Latest Unstable Version](https://poser.pugx.org/dynamic/silverstripe-elemental-blocks/v/unstable)](https://packagist.org/packages/dynamic/silverstripe-elemental-blocks)
@@ -18,38 +12,39 @@ Additional elements for the [SilverStripe Elemental](https://github.com/dnadesig
 
 * SilverStripe ^4.0
 * SilverStripe Elemental ^2.0
-* Silverstripe Geocoder ^1.0
-* SilverStripe Linkable ^2.0
-* Display Logic ^2.0
 
-## Installation
+## Usage
 
-`composer require dynamic/silverstripe-elemental-blocks`
+To start a new website with Dynamic's elemental blocks installed:
 
-## Usage
+```
+composer create-project dynamic/silverstripe-elemental-blocks website ^2
+```
+
+Or to include blocks into your existing website:
+
+```
+composer require dynamic/silverstripe-elemental-blocks
+```
+
+## Included blocks
 
 Elemental Blocks will add the following Elements to your site:
 
-* Call To Action (button link)
-* Customer Service (map, directions, contact info)
-* Embeded Code (iframes, javascript)
-* Featured Content (large image, headline, description, link)
-* Image (single image)
-* oEmbed (YouTube, SoundCloud, etc)
-* Photo Gallery (thumbnails, lightbox)
-* Promos (small image, headline, description, link)
-* Section Navigation (child pages / pages in current level)
-
-## Getting more elements
-
-Other elemental modules by Dynamic:
-
-* [SilverStripe Elemental Accordion Block](https://github.com/dynamic/silverstripe-elemental-acordion)
-* [SilverStripe Elemental Count Down Block](https://github.com/dynamic/silverstripe-elemental-countdown)
-* [SilverStripe Elemental Flexslider](https://github.com/dynamic/silverstripe-elemental-flexslider)  
-* [SilverStripe Elemental Blog](https://github.com/dynamic/silverstripe-elemental-blog)  
-* [SilverStripe Elemental Sponsors](https://github.com/dynamic/silverstripe-elemental-sponsors)  
-* [SilverStripe Elemental Testimonials](https://github.com/dynamic/silverstripe-elemental-testimonials) 
+* [Accordion](https://github.com/dynamic/silverstripe-elemental-accordion): content in collapsable panels
+* [Countdown](https://github.com/dynamic/silverstripe-elemental-countdown): time left until a set date and time
+* [Customer Service](https://github.com/dynamic/silverstripe-elemental-customer-service): map, directions, and contact info for your location
+* [Embeded Code](https://github.com/dynamic/silverstripe-elemental-embedded-code): embed code like iframes, javascript
+* [Featured Content](https://github.com/dynamic/silverstripe-elemental-features): large image, headline, description, link. one per row
+* [Flexslider](https://github.com/dynamic/silverstripe-elemental-flexslider): Flexslider slideshow
+* [Gallery](https://github.com/dynamic/silverstripe-elemental-gallery): display a collection of images
+* [Image](https://github.com/dynamic/silverstripe-elemental-image): single image
+* [oEmbed](https://github.com/dynamic/silverstripe-elemental-oembed): embed content from YouTube, SoundCloud, etc
+* [Promos](https://github.com/dynamic/silverstripe-elemental-promos): small image, headline, description, link. 3 to 4 per row
+* [Recent Blog Posts](https://github.com/dynamic/silverstripe-elemental-blog): list of the most recent posts of a specific blog
+* [Section Navigation](https://github.com/dynamic/silverstripe-elemental-section-navigation): list of child pages or pages in current level
+* [Sponsors](https://github.com/dynamic/silverstripe-elemental-sponsors): sponsor logos in a row
+* [Testimonials](https://github.com/dynamic/silverstripe-elemental-testimonials): list of customer testimonials, filter by category
 
 ## Configuration
 

diff --git a/composer.json b/composer.json
@@ -1,11 +1,12 @@
 {
     "name": "dynamic/silverstripe-elemental-blocks",
-    "type": "silverstripe-vendormodule",
-    "description": "Additional elements for the SilverStripe Elemental module",
+    "type": "silverstripe-recipe",
+    "description": "A recipe to require additonal elements for the SilverStripe Elemental module",
     "keywords": [
         "silverstripe",
         "elemental",
-        "blocks"
+        "blocks",
+        "recipe"
     ],
     "license": "BSD-3-Clause",
     "authors": [
@@ -17,11 +18,22 @@
     ],
     "require": {
         "dnadesign/silverstripe-elemental": "^2@dev",
-        "dynamic/silverstripe-geocoder": "^1@dev",
-        "dynamic/silverstripe-elemental-baseobject": "^1@dev",
+        "dynamic/silverstripe-elemental-accordion-block": "^1.0@dev",
+        "dynamic/silverstripe-elemental-blog": "^1.0@dev",
+        "dynamic/silverstripe-elemental-countdown-block": "^1.0@dev",
+        "dynamic/silverstripe-elemental-customer-service": "^1.0@dev",
+        "dynamic/silverstripe-elemental-embedded-code": "^1.0@dev",
+        "dynamic/silverstripe-elemental-features": "^1.0@dev",
+        "dynamic/silverstripe-elemental-flexslider": "^1.0@dev",
+        "dynamic/silverstripe-elemental-gallery": "^1.0@dev",
+        "dynamic/silverstripe-elemental-image": "^1.0@dev",
+        "dynamic/silverstripe-elemental-oembed": "^1.0@dev",
+        "dynamic/silverstripe-elemental-promos": "^1.0@dev",
+        "dynamic/silverstripe-elemental-section-navigation": "^1.0@dev",
+        "dynamic/silverstripe-elemental-sponsors": "^1.0@dev",
+        "dynamic/silverstripe-elemental-testimonials": "^1.0@dev",
         "silverstripe/recipe-cms": "^1.0@dev",
-        "silverstripe/vendor-plugin": "^1.0@dev",
-        "unclecheese/display-logic": "^2.0@dev"
+        "silverstripe/recipe-plugin": "^1"
     },
     "require-dev": {
         "phpunit/PHPUnit": "^5.7",
@@ -39,16 +51,6 @@
             "dev-master": "2.0.x-dev"
         }
     },
-    "autoload": {
-        "psr-4": {
-            "Dynamic\\Elements\\": "src/",
-            "Dynamic\\Elements\\Tests\\": "tests/"
-        }
-    },
     "minimum-stability": "dev",
-    "prefer-stable": true,
-    "scripts": {
-        "lint": "vendor/bin/phpcs src/ tests/",
-        "lint-clean": "vendor/bin/phpcbf src/ tests/"
-    }
+    "prefer-stable": true
 }