Skip to content

Commit 997a4a4

Browse files
committed
v.0.2.0 🎉
1 parent 706a134 commit 997a4a4

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Steller CSS
1+
# StellerCSS
22
Steller is a utility-first CSS framework that serves as the foundation of your application's design system. It includes built-in smart defaults for building responsive, accesible, and visually consistent user interfaces. Unlike other CSS frameworks, Steller has no opinion on the actual end appearance of your application, it is simply a bridge for your design system and your application's styling.
33

44
## Features
@@ -8,7 +8,7 @@ Steller is a utility-first CSS framework that serves as the foundation of your a
88
* Built-in responsive typography best practices ✍️
99
* Clear, predictable class syntax 🔍
1010
* SASS based (No CSS-in-JS complexity) ✨
11-
* Only 12kb gzipped 🚀
11+
* Add your own custom classes 🚀
1212

1313
## Installation
1414

@@ -31,7 +31,7 @@ yarn add steller-css
3131
// Assuming you are using webpack
3232

3333
@import 'steller-theme'; // Your config file
34-
@import '~steller-css/index'; // Steller
34+
@import '~steller-css/index'; // StellerCSS
3535
```
3636

3737
## Example Projects
@@ -47,6 +47,10 @@ All config variables are optional to define as they already have default values.
4747

4848
```scss
4949
$steller-colors: (
50+
// brand colors
51+
'primary': #586f7c,
52+
'secondary': #b8dbd9,
53+
5054
'dwight-schrute': #0FF1C3,
5155
'a-song-of-this-and-fire': #1CE,
5256
);
@@ -547,7 +551,7 @@ $my-module-name: (
547551
</span>
548552
```
549553

550-
Classes via steller-modules automatically have all prefixed variants generated.
554+
Classes via steller modules automatically have all prefixed variants generated.
551555

552556
---
553557

@@ -559,7 +563,7 @@ Classes via steller-modules automatically have all prefixed variants generated.
559563

560564
* Transform transition speed classes
561565

562-
#### Steller family
566+
#### Steller Family
563567

564568
* [steller-vue-transitions](https://github.com/tjhillard/steller-vue-transitions)
565569

example-theme.scss

+2-4
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,12 @@ $steller-transform-distance-xl: 8px;
163163

164164
/**
165165
* --------------------------------------------------------------
166-
* Modules (WIP)
166+
* Modules
167167
*
168168
* Modules allow you to extend Steller by providing a map
169169
* of additional classes. By default, modules are applied
170170
* to all variant types (responsive, hover, focus, active).
171171
* --------------------------------------------------------------
172172
*/
173173

174-
// Example
175-
// @import '~steller-vue-transitions/index';
176-
// $steller-modules: ($steller-vue-transitions);
174+
$steller-modules: ();

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "steller-css",
3-
"version": "0.2.0-alpha.0",
3+
"version": "0.2.0",
44
"description": "A utility-first CSS framework that serves as the foundation of your application's design system",
55
"main": "index.js",
66
"author": "TJ Hillard",

0 commit comments

Comments
 (0)