Permalink
Browse files

Updated README to reflect 0.2.0 release and current status

  • Loading branch information...
bmavity committed Sep 7, 2010
1 parent 30a21e5 commit 7fec56ff62c036c6d681b0513387a02559c7d268
Showing with 41 additions and 0 deletions.
  1. +41 −0 README.md
View
@@ -1,6 +1,47 @@
# scss-js
## A JavaScript implementation of SCSS (Sassy CSS)
+## API
+
+### Connect Compiler
+
+ var sys = require('sys'),
+ fs = require('fs'),
+ compiler = require('../src/scssCompiler');
+
+ fs.readFile(__dirname + '/blog.scss', function(err, scssFile) {
+ compiler.compile(scssFile.toString(), function(err, css) {
+ if(err) {
+ sys.puts(sys.inspect(err));
+ } else {
+ sys.puts(css);
+ }
+ });
+ });
+
+The compile function takes a string and returns another string with the file's css.
+
+## Where Does the Project Stand?
+
+### What's Usable?
+ * CSS Selectors
+ * Nested Rules
+ * Variables
+ * Fixed Mixins
+
+### What Needs Work
+ * CSS Selectors
+ * Variable and Mixin names
+
+### What is Unimplemented?
+ * Parameterized Mixins
+ * Functions
+
+## Next Release (0.2.0)
+
+Full CSS Selector implementation
+
+
## Special Thanks
I would like to give special thanks to [Hampton Catlin](http://hamptoncatlin.com),

0 comments on commit 7fec56f

Please sign in to comment.