Skip to content

Commit afc918f

Browse files
committed
Prepare for release
1 parent a1f4d91 commit afc918f

5 files changed

Lines changed: 44 additions & 38 deletions

File tree

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,40 @@
11
# knopf.css
22

3-
[<img src="https://knopf.dev/logo.svg" alt="Knopf logo" width="88" height="88">][knopf.css]
3+
Open source button system leveraging CSS custom properties, designed for rapid prototyping and production–ready applications.
44

5-
[knopf.css] is a CSS library that provides buttons
5+
## Installation
66

7-
## Usage
7+
The easiest way to “install” **knopf.css** on your proyect is to include the stylesheet on your website.
88

99
```html
10-
<link href="https://unpkg.com/knopf.css" rel="stylesheet" />
10+
<link rel="stylesheet" href="https://unpkg.com/knopf.min.css">
1111
```
1212

13-
## Install
13+
You can also install it via your favorite package manager:
1414

15-
```sh
16-
# npm
15+
### Install with npm
16+
```bash
1717
npm install knopf.css
18+
```
1819

19-
# yarn
20+
### Install with yarn
21+
```bashf
2022
yarn add knopf.css
2123
```
2224

23-
**Download**
25+
You will then need to import it wherever you are currently importing your styles
26+
```node
27+
import 'knopf.css'
28+
```
29+
30+
## Usage
2431

25-
See https://github.com/systemsthinkinginstitute/knopf.css/blob/master/knopf.css
32+
Just add the `knopf` class name to any anchor, button, or label, to start using the built-in component styles and modifiers. For the list of available features, check out [https://knopf.dev/#Features](https://knopf.dev/#Features); or use the [playground](https://knopf.dev/#Playground) to see them in action.
2633

27-
## Contributing
34+
The true power of the library lies in its extensibility. Ideally you would modify the default values (like border-radius or the initial hsl color) to match your product’s branding. You are also encouraged to build your own modifiers to achieve whatever styles might be missing.
2835

29-
Please read the [contribution guidelines](CONTRIBUTING.md) in order to make the
30-
contribution process easy and effective for everyone involved.
36+
It is worth noting that **knopf.css** is completely framework agnostic and should work whether you are using jQuery, React, Vue, Bootstrap, Tailwind or any other tool.
37+
38+
## Contributing
3139

32-
[knopf.css](https://knopf.dev/)
40+
Please read the [contribution guidelines](CONTRIBUTING.md) in order to make the contribution process easy and effective for everyone involved.

knopf.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/*! Knopf v1.0.0 | MIT License | https://knopf.dev/ */
1+
/*! knopf v1.0.0 | MIT License | https://knopf.dev/ */
22

33
:root {
44
/* ==========================================================================

knopf.min.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "knopf.css",
3-
"version": "0.2.4",
4-
"description": "Componentized styles for your buttons",
3+
"version": "1.0.0",
4+
"description": "Open source button system leveraging CSS custom properties, designed for rapid prototyping and production–ready applications",
55
"author": {
6-
"name": "Team.Video",
6+
"name": "team.video",
77
"email": "tech@team.video",
88
"url": "https://team.video/"
99
},
@@ -28,16 +28,14 @@
2828
},
2929
"scripts": {
3030
"build": "uglifycss knopf.css > knopf.min.css",
31-
"lint": "stylelint knopf.css",
32-
"prepare": "npm run test",
33-
"test": "npm run lint"
31+
"lint": "stylelint knopf.css"
3432
},
3533
"keywords": [
3634
"buttons",
3735
"css"
3836
],
3937
"devDependencies": {
40-
"stylelint": "^13.2.1",
38+
"stylelint": "^13.6.1",
4139
"stylelint-config-standard": "^20.0.0",
4240
"uglifycss": "0.0.29"
4341
},

0 commit comments

Comments
 (0)