Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Ohswedd committed Nov 30, 2024
1 parent bd9bf21 commit 41d4228
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
![Downloads](https://img.shields.io/github/downloads/altxriainc/kromacss/total)
![Status](https://img.shields.io/badge/status-stable-green)
![CodeQL](https://github.com/altxriainc/kromacss/workflows/CodeQL/badge.svg)
![npm version](https://img.shields.io/npm/v/kromacss)
![npm downloads](https://img.shields.io/npm/dt/kromacss)
![License: CC BY-ND 4.0](https://img.shields.io/badge/License-CC%20BY--ND%204.0-lightgrey.svg)

**KromaCSS** is a modern, lightweight, and dependency-free CSS framework designed for simplicity, speed, and adaptability. Built with the latest CSS features and enhanced by vanilla JavaScript, KromaCSS offers a robust collection of responsive, modular components. Ideal for developers who want efficient, adaptable styling for both personal and commercial projects without the need for any extra requirements.
Expand Down Expand Up @@ -35,6 +37,38 @@ Include the following lines in your HTML file to load KromaCSS.
<script src="https://cdn.jsdelivr.net/gh/altxriainc/kromacss@latest/src/js/bundle.js"></script>
```

### Step 2: Install via NPM

You can also install KromaCSS via npm:

```bash
npm install kromacss
```

Then import KromaCSS into your JavaScript or CSS project:

#### Import CSS and JavaScript in Your JavaScript File

```javascript
// Import KromaCSS styles
import 'kromacss/src/css/bundle.css';

// Import KromaCSS functionality
import 'kromacss/src/js/bundle.js';
```

#### Directly Include Files in HTML (Post npm Install)

If not using a bundler, link the installed files directly in your HTML:

```html
<!-- KromaCSS Stylesheet -->
<link rel="stylesheet" href="node_modules/kromacss/src/css/bundle.css">

<!-- KromaCSS JavaScript -->
<script src="node_modules/kromacss/src/js/bundle.js"></script>
```

### Step 2: Add Components

KromaCSS provides ready-to-use components. For example, to create a button:
Expand Down

0 comments on commit 41d4228

Please sign in to comment.