From 744c9dcee01dcd8316fc5c4ec24b0d3e69cde715 Mon Sep 17 00:00:00 2001 From: MightyPork Date: Tue, 31 Mar 2015 02:12:55 +0200 Subject: [PATCH] improved readme --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1aaf4e4..8248576 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,13 @@ ABBR Abbr is a JavaScript library / function for finding, highlighting and annotating abbreviations in text. -It needs no extra markup, all is done automatically. Just tell it what words you want to explain, and it'll do it. +It goes through text and wrapps acronyms (or anything you want) in `` tags (or other of choice), and gives them +`title` attribute with explanation (again, customizable). + +It needs **no extra markup**, all is done automatically. Just tell it what words you want to explain, and it'll do it. + +Usage +----- Abbr takes the following (default) arguments: @@ -28,15 +34,7 @@ Abbr takes the following (default) arguments: All config options are optional (though, obviously, you don't want to leave `words` empty). -To run it, simply call: - -```js -abbr({ - // Your options here -}); -``` - -For example: +To run it, simply call (example): ```js abbr({