diff --git a/README.md b/README.md index 2b8ecaa5093..709b8935deb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # Patternfly Seed -Patternfly Seed is an open source build scaffolding utility for web apps. The primary purpose of this project is to give developers a jump start when creating new projects that will use patternfly. A secondary purpose of this project is to serve as a reference for how to configure various aspects of an application that uses patternfly. +Patternfly Seed is an open source build scaffolding utility for web apps. The primary purpose of this project is to give developers a jump start when creating new projects that will use patternfly. A secondary purpose of this project is to serve as a reference for how to configure various aspects of an application that uses patternfly, webpack, react, typescript, etc. + +Out of the box you'll get an app layout with chrome (header/sidebar), routing, build pipeline, test suite, and some code quality tools. Basically, all the essentials. + +Screen Shot 2019-07-09 at 9 55 45 AM ## Quick-start ```bash @@ -37,24 +41,32 @@ Launch a tool to inspect the bundle size * [Jest Config](./jest.config.js) * [Editor Config](./.editorconfig) -## Image Support +## Raster Image Support -To use an image asset that's shipped with patternfly core, you'll prefix the paths with `@assets`. `@assets` is an alias for the patternfly assets directory in node_modules. +To use an image asset that's shipped with patternfly core, you'll prefix the paths with "@assets". `@assets` is an alias for the patternfly assets directory in node_modules. -`import imgSrc from '@assets/images/g_sizing.png';` -Then you can use it like: -`Some image` +For example: +```js +import imgSrc from '@assets/images/g_sizing.png'; +Some image +``` -You can use a similar technique to import assets from your local app, just prefix the paths with. `@app`. -`import loader from '@app/assets/images/loader.gif';` -`