Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mehmetb authored Mar 24, 2018
1 parent c87ab52 commit 19963e4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# css-server
*On the fly css module builder*

### What is css-server?

css-server is inspired by [css-modules](https://github.com/css-modules/css-modules). It converts "global" css to "local" and provides an object so you can access your classes in javascript code.

### How it works?

It intercepts all HTTP GET requests for *.css files and returns a custom javascript which exports an object containing all the class names.
Before exporting the object, it appends the converted css to the head wrapped in a style tag.

### How about source maps?

Currently, we generate very primitive source maps. We plan to have full source-map support.

### How to contribute?

- You can open an issue.
- You can create a pull request.

0 comments on commit 19963e4

Please sign in to comment.