Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
fix for external links
added an optional requirements info docs.
  • Loading branch information
hdpero committed Jul 13, 2018
1 parent e1c8d2f commit d22a615
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Introduction

This module extends a [SilverStripe Elemental Blocks](https://github.com/silverstripe/silverstripe-elemental-blocks) to enhance its functionalities with predefined sets of Classes of Styling elements.
This module extends a [SilverStripe Elemental Blocks](https://github.com/dnadesign/silverstripe-elemental) to enhance its functionalities with predefined sets of Classes of Styling elements.

Predefined Styling classes:
- **StylingHeight** - changes a height of a Block
Expand All @@ -34,7 +34,7 @@ The module provides basic markup for each of the stylings but you have an option
```
composer require fractas/elemental-stylings
```
- Follow an instructions for installation of Elemental Blocks module
- Follow an instructions for installation of [Elemental Blocks module](https://github.com/dnadesign/silverstripe-elemental#installation)
- Apply a desired Styling Class extension on Block class _(ie. ElementContent that ships with Core module)_
**mysite/\_config/elements.yml**
```yaml
Expand All @@ -47,7 +47,12 @@ composer require fractas/elemental-stylings
- Fractas\ElementalStylings\StylingVerticalAlign
- Fractas\ElementalStylings\StylingWidth
```
- Add an desired styles based on your preferences, see Configuration example
- Add an desired styles based on your preferences, see [Configuration example](#full-configuration-example)
- Optionaly, you can require basic CSS stylings provided with this module to your controller class like:
**mysite/code/PageController.php**
```php
Requirements::css('fractas/elemental-stylings:client/dist/css/stylings.css');
```
- Build and flush your project ```vendor/bin/sake dev/build flush=1```


Expand Down

0 comments on commit d22a615

Please sign in to comment.