You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,18 @@
1
-
# CastleCSS Buttons Files
1
+
# CastleCSS Icons Files
2
+
CastleCSS basic button module
3
+
2
4

3
5
4
6
## CastleCSS Framework
5
-
The buttons files are part of the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss), you need this, the [castlecss-core](https://github.com/CastleCSS/castlecss) or create your own variables files in order to make castlecss-buttons work.
7
+
The buttons module is part of the [CastleCSS Meta Package](https://github.com/CastleCSS/castlecss), you need this, the [castlecss-core](https://github.com/CastleCSS/castlecss) or create your own variables files in order to make castlecss-icons work.
8
+
9
+
Since castlecss-buttons v0.5 the castlecss-core is automatically installed into your node_modules too.
6
10
11
+
Even easier: Download the [CastleCSS Boilerplate](https://www.github.com/CastleCSS/castlecss-boilerplate). All Packages are included + examples and project setup
7
12
8
13
## How to install
9
-
- Install via [NPM](https://www.npmjs.com/): ```npm install castlecss-buttons```
14
+
- Download the [CastleCSS Boilerplate](https://www.github.com/CastleCSS/castlecss-boilerplate). All Packages are included + examples and project setup
15
+
- Install via [NPM](https://www.npmjs.com/): ```npm install castlecss-icons```
10
16
- Require it in your own NPMJS package
11
17
- Download or clone the package
12
18
@@ -16,10 +22,10 @@ CastleCSS is built so it's easy to update, you can just download make it your ow
16
22
```npm update castlecss-buttons```
17
23
18
24
## Documentation and examples
19
-
You can find the documentation and examples at http://www.castlecss.com and [castlecss-docs](https://github.com/CastleCSS/castlecss-buttons)
25
+
You can find the documentation and examples at http://www.castlecss.com and [castlecss-docs](https://github.com/CastleCSS/castlecss-docs)
20
26
21
27
## Setup
22
-
Your project should have a setup similair to this (included in the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss)):
28
+
Your project should have a setup similair to this (included in the [CastleCSS Boilerplate](https://github.com/CastleCSS/castlecss-boilerplate)):
23
29
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
24
30
25
31
```
@@ -38,7 +44,7 @@ With this you make sure your own variables overwrite the castle-core variables a
38
44
```
39
45
40
46
### Main.scss
41
-
Your main.scss should have a setup similair to this (included in the [Full CastleCSS Package](https://github.com/CastleCSS/castlecss)):
47
+
Your main.scss should have a setup similair to this (included in the [CastleCSS Boilerplate](https://github.com/CastleCSS/castlecss-boilerplate)):
42
48
43
49
```
44
50
/* core variable files */
@@ -56,3 +62,11 @@ Your main.scss should have a setup similair to this (included in the [Full Castl
56
62
--------------------------------------
57
63
*/
58
64
```
65
+
66
+
## Roadmap
67
+
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.
68
+
69
+
Please see the [ROADMAP.MD from the CastleCSS Meta Package](https://github.com/CastleCSS/castlecss/blob/master/ROADMAP.md) for our current plans for the future.
70
+
71
+
## Contributing
72
+
Want to contribute? We'd love your help, please take a look at the roadmap or submit new suggestions.
0 commit comments