From fb8bb1889e36328c1254c173b2730803c4c32b85 Mon Sep 17 00:00:00 2001 From: ryzy Date: Thu, 6 Nov 2014 22:57:11 +0000 Subject: [PATCH] README update --- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 93778f2..b05008b 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,29 @@ -M12.Foundation -============= +# M12.Foundation - Foundation components inside TYPO3 Neos -TYPO3 Neos package implementing Foundation 5 elements. +M12.Foundation aims to implement all [Zurb Foundation](http://foundation.zurb.com/) components, in the best possible way, inside TYPO3 Neos CMS. -## Instalation +The best way is to install it together with [M12.FoundationSite](https://github.com/million12/M12.FoundationSite) Neos site package. It **conflicts with NeosDemoTypo3Org**, so remember to remove `typo3/neosdemotypo3org` dependency from your `composer.json`. -From command line (from Neos root directory) type: +## Usage -```composer require m12/neos-foundation:dev-master``` +You can try ready-to-use [neos-typostrap-distribution](https://github.com/million12/neos-typostrap-distribution), TYPO3 Neos distribution which has this installed and configured. -**Alternatively**, you might add it manually to composer.json: -``` +Alternatively, include in your main `composer.json` file: +``` json + "repositories": [ + { "type": "git", "url": "https://github.com/million12/M12.FoundationSite" } + ], "require": { - ... - "m12/neos-foundation": "dev-master" + # standard dependencies here... + # "typo3/neosdemotypo3org": "x.y.z", # Remember to remove this one + "m12/neos-foundation": "dev-master", + "m12/neos-foundation-site": "dev-master" }, -``` -and then execute `composer install`. +``` +and run `composer install` -After all call: -```./flow flow:cache:flush --force && ./flow cache:warmup``` +## Author(s) + +* Marcin Ryzycki marcin@m12.io +* Samuel Ryzycki samuel@m12.io