From f9a6a179d1453b79d8a0ee4b93e0ecac8b25be1f Mon Sep 17 00:00:00 2001 From: Rafael Caricio Date: Sat, 6 Sep 2014 19:46:07 +0200 Subject: [PATCH] Organize code --- README.md | 30 +++++++++++++++++++++++++++-- index.js | 1 + gradient-parser.js => lib/parser.js | 0 package.json | 2 +- 4 files changed, 30 insertions(+), 3 deletions(-) create mode 100644 index.js rename gradient-parser.js => lib/parser.js (100%) diff --git a/README.md b/README.md index 59e839e..083bc20 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# gradient-parser +# Gradient Parser ## About @@ -9,7 +9,33 @@ Parse CSS3 gradient definition and returns AST. ### JavaScript ```JavaScript - // TODO + var gradient = require('gradient-parser'); + var obj = gradient.parse('linear-gradient(30deg, #000, transparent)'); + console.log(JSON.stringify(obj, null, 2)); +``` + +Results in: + +```JSON +[ + { + "type": "linear-gradient", + "orientation": { + "type": "angular", + "value": "30" + }, + "colorStops": [ + { + "type": "hex", + "value": "000" + }, + { + "type": "literal", + "value": "transparent" + } + ] + } +] ``` ## Install Choices diff --git a/index.js b/index.js new file mode 100644 index 0000000..51cfecd --- /dev/null +++ b/index.js @@ -0,0 +1 @@ +exports.parse = require('./lib/parser'); diff --git a/gradient-parser.js b/lib/parser.js similarity index 100% rename from gradient-parser.js rename to lib/parser.js diff --git a/package.json b/package.json index f006c89..60212b8 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ "type": "git", "url": "git://github.com/rafaelcaricio/gradient-parser.git" }, - "main": "gradient-parser.js", + "main": "index.js", "scripts": { "test": "grunt" },