castlecss-stickers
v1.0.0
Published
Easy to use stickers for CastleCSS
Downloads
58
Readme
CastleCSS Stickers
This is a subpackage for CastleCSS with example stickers to help you get started.
CastleCSS Framework
Quickstart: Download the CastleCSS Boilerplate. All Packages are included + examples and project setup
The sticker module is part of the CastleCSS Meta Package, you need this, the castlecss-core or create your own variables files in order to make castlecss-stickers work.
Requirements
The castlecss-core is automatically installed as a peerDependency too.
How to install
- Download the CastleCSS Boilerplate. All Packages are included + examples and project setup
- Install via NPM:
npm install castlecss-stickers
- Require it in your own NPMJS package
- Download or clone the package
Updating files
CastleCSS is built so it's easy to update, you can just download and make it your own as long as you don't ovewrite the core files.
npm update castlecss-stickers
Documentation and examples
You can find the documentation and examples at http://www.castlecss.com/stickers.html
Setup
Your project should have a setup similair to this (included in the CastleCSS Boilerplate): With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
| Your project/
|
|-- scss/
| |-- /* Custom project specific scss files here */
| |-- Main.scss
| |
|-- node_modules/
| |
| | /* CastleCSS files included automatically here */
| | castlecss-core/
| | castlecss-stickers/
| | castlecss-etc ;)/
Main.scss
Your main.scss should have a setup similair to this (included in the CastleCSS Boilerplate):
/* core variable files */
@import "path/to/castlecss-core/sass/variables";
/* Your own variables so they overwrite the core */
@import "variables";
/* rest of core files */
@import "node_modules/castlecss-core/sass/main";
@import "node_modules/castlecss-stickers/sass/main";
/* Include your own files below this line
--------------------------------------
*/
Roadmap
We're currently working hard on making the CastleCSS expansions and improvements. CastleCSS is made to serve as lightweight basis for tailor made software but we do want to give you the option to install a few modules to make your life easier.
Please see the ROADMAP.MD from the CastleCSS Meta Package for our current plans for the future.
Contributing
Want to contribute? We'd love your help, please take a look at the roadmap or submit new suggestions.