diff --git a/README.md b/README.md index 76bd83d..b08fa59 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,45 @@ A mildly opinionated Eleventy starter project. -[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/mattdecamp/eleventonia) \ No newline at end of file +[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/mattdecamp/eleventonia) + +## Features + +* HTML Minification +* CSS Pipeline (Sass > CleanCSS) +* Eleventy SVG Icon Sprites +* Eleventy RSS +* Date Formatting Filter + +## Getting Started + +Navigate to the root folder of the site and + +``` +npm install +``` + +Run the development environment + +``` +npm run eleventy:dev +``` + +Build for production + +``` +npm run eleventy:prod +``` + +For additional eleventy commands, visit the [Eleventy command line usage page](https://www.11ty.dev/docs/usage/). +## CSS + + +## SVG Icon Sprites + +## Credits and Thanks To + +Zach Leatherman +Max Böck +Andy Bell +Phil Hawksworth \ No newline at end of file