From 315f245c9c18fa80c27dd5257af026a8a2f7044c Mon Sep 17 00:00:00 2001 From: Kevin MacMartin Date: Tue, 30 Jun 2015 17:58:12 -0400 Subject: [PATCH] Add a description of the plugin to the README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index eaff8b3..14ed434 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ A JavaScript plugin to contain an element within its parent element. +## Description + +The plugin scales an element to the minimum size required for it to be completely contained within its parent, and retains its original aspect ratio by cropping portions that don't fit based on its vertical and horizontal alignment (by default both are set to: `middle`). + ## Features * Pure JavaScript with no dependencies