Skip to content

Commit

Permalink
DOCS: Adjust first section of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mficzel committed Jul 20, 2018
1 parent 835750a commit 83a93e9
Showing 1 changed file with 20 additions and 5 deletions.
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,22 @@

## Responsive Images for Neos

This package implements responsive-images for Neos.
This package implements responsive-images for Neos for beeing used via Fusion.

```
imageSource = Sitegeist.Kaleidoscope:DummyImageSource {
width = 800
height = 200
}
renderer = afx`
<Sitegeist.Kaleidoscope:Image
imageSource={props.imageSource}
srcset="320w, 400w, 600w, 800w, 1000w, 1200w, 1600w"
sizes="(min-width: 800px) 1000px, (min-width: 480px) 800px, (min-width: 320px) 440px, 100vw"
/>
`
```

By separating the aspects of image-definition, size-constraining and rendering
we enable the separation of those aspects into different fusion-components.
Expand All @@ -13,10 +28,10 @@ Sitegeist.Monocle living styleguide.

Sitegeist.Kaleidoscope comes with four Fusion-ImageSources:

- Assets: Images uploaded by Editors
- DummyImages: Dummyimages created by a local service
- Resources: Static resources from Packages
- static Uris: any Url
- Sitegeist.Kaleidoscope:AssetImageSource: Images uploaded by Editors
- Sitegeist.Kaleidoscope:DummyImageSource: Dummyimages created by a local service
- Sitegeist.Kaleidoscope:ResourceImageSource: Static resources from Packages
- Sitegeist.Kaleidoscope:UriImageSource: any Url

### Authors & Sponsors

Expand Down

0 comments on commit 83a93e9

Please sign in to comment.