diff --git a/README.md b/README.md index 32c9070..0713c0c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # jekyll-multisites -Jekyll Multisites allows granular control over sharing codebases, plugins, files & assets across multiple Jekyll builds. +Jekyll Multisites allows control for sharing files & directories between multiple Jekyll sites. This allows a developer to share project assets, images, css, scripts etc... across sites. + +### Inspiration + +This project came out of a need to share code & modular web components across a system of sites, Branding assets, shared call to action banners, modules of custom html, css & javscript, shared vendor assets plugins & gems. ### Purpose -The purpose of `jekyll-multisites` is to demonstrate the capabilities of Jekyll as a tool for sharing assets across multiple builds. HTML, CSS, JavaScript, image assets, plugins & gems can be shared as the source files for a system of websites. +The purpose of `jekyll-multisites` is to demonstrate the capabilities of Jekyll as a tool for sharing assets across multiple builds. HTML, CSS, JavaScript, image assets, plugins & gems can be shared as the source files for a system of static JAMstack websites. ### Usage @@ -12,18 +16,21 @@ To spin up the example sites first download the git repository: `$ git clone git #### Running the sites individually - -To build & serve either site run one of the following commands from the repository +Install Bundler if you don't already have it: ``` -$ bundle exec jekyll serve --config _config_site_one.yml -$ bundle exec jekyll serve --config _config_site_two.yml +$ gem install bundler ``` -### Inspiration +Intall the projects needed gems: -Inspiration for this project came out of a need to share modular web components across a system of sites, Branding assets, shared call to action banners, modules of custom html, css & javscript & shared vendor assets. +``` +$ bundle install +``` -### Default Application Structure +To build & serve either site run one of the following commands from the repository directory: -... I'll get there don't worry, in the mean time shoot me a message on twitter [@designaroni](https://twitter.com/designaroni) +``` +$ bundle exec jekyll serve --config _config_site_one.yml +$ bundle exec jekyll serve --config _config_site_two.yml +```