Skip to content

Commit 1ed564f

Browse files
author
Darius Rosendahl
committed
Merge branch 'release/Release_for_v0.5'
2 parents 6002791 + 834d1fb commit 1ed564f

File tree

4 files changed

+32
-9
lines changed

4 files changed

+32
-9
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.log
2+
thumbs.db
3+
node_modules

.npmignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*.log
2+
thumbs.db
3+
node_modules

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
# CastleCSS Buttons Files
1+
# CastleCSS Icons Files
2+
CastleCSS basic button module
3+
24
![CastleCSS logo @CastleCss.com](https://www.doordarius.nl/castlecss-logo-250.png)
35

46
## 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.
610

11+
Even easier: Download the [CastleCSS Boilerplate](https://www.github.com/CastleCSS/castlecss-boilerplate). All Packages are included + examples and project setup
712

813
## 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```
1016
- Require it in your own NPMJS package
1117
- Download or clone the package
1218

@@ -16,10 +22,10 @@ CastleCSS is built so it's easy to update, you can just download make it your ow
1622
```npm update castlecss-buttons```
1723

1824
## 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)
2026

2127
## 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)):
2329
With this you make sure your own variables overwrite the castle-core variables and your setup is still updatable.
2430

2531
```
@@ -38,7 +44,7 @@ With this you make sure your own variables overwrite the castle-core variables a
3844
```
3945

4046
### 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)):
4248

4349
```
4450
/* core variable files */
@@ -56,3 +62,11 @@ Your main.scss should have a setup similair to this (included in the [Full Castl
5662
--------------------------------------
5763
*/
5864
```
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.

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "castlecss-buttons",
3-
"version": "0.4.1",
4-
"description": "Button files for CastleCSS",
3+
"version": "0.5.0",
4+
"description": "Buttons module for CastleCSS",
55
"main": "index.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"
@@ -26,5 +26,8 @@
2626
"bugs": {
2727
"url": "https://github.com/CastleCSS/castlecss-buttons/issues"
2828
},
29-
"homepage": "https://github.com/CastleCSS/castlecss-buttons#readme"
29+
"homepage": "https://github.com/CastleCSS/castlecss-buttons#readme",
30+
"dependencies": {
31+
"castlecss-core": "^2.0.1"
32+
}
3033
}

0 commit comments

Comments
 (0)