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
+14-13Lines changed: 14 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,20 +9,28 @@
9
9
<palign="center">A drop-in utility component CSS library for lazy mammals.<br />Created by <ahref="https://github.com/devmount"target="_blank">devmount</a>.</p>
10
10
</p>
11
11
12
-
> [!IMPORTANT]
13
-
> Sloth.css is still heavily work-in-progress. The package is not yet published.
12
+
Check [the documentation](https://slothcss.devmount.com) to see it live in action. Sloth.css aims to be:
14
13
15
-
Check [the documentation](https://slothcss.devmount.com) to see it in action.
14
+
- Lightweight (7.3KB gzipped)
15
+
- Responsive and mobile-friendly
16
+
- Beautiful per default but heavily customisable
17
+
- Working for all modern browsers
16
18
17
19
## Installation
18
20
19
-
Include the following CSS file in your HTML head to get the complete package (drop-in core styles, utility classes and CSS components):
21
+
See the [installation instructions](https://slothcss.devmount.com/getting-started/installation) for different setup options. Add it to your project's dependencies:
22
+
23
+
```bash
24
+
npm i @devmount/sloth.css
25
+
```
26
+
27
+
Or for a quick start include the following CSS file in your HTML head to get the complete package (drop-in core styles, utility classes and CSS components):
@@ -32,14 +40,7 @@ If you just want to use the drop-in core styles, the utility classes or the CSS
32
40
33
41
## Features
34
42
35
-
Sloth.css can be used as drop-in CSS library, or additionally with curated utility classes or even with a set of handcrafted ready-to-copy components. Styles are opinionated (then again: which styles are not), and crafted to prioritize visual usability over trends such as flat design. For example: Elements where you type in (like input fields) are actually inset, elements that are clickable (like buttons) are actually outstanding, tabs are connected to the content they activate etc.
36
-
37
-
Also, Sloth.css aims to be:
38
-
39
-
- Lightweight (3.8KB gzipped)
40
-
- Responsive and mobile-friendly
41
-
- Beautiful per default but customisable
42
-
- Working for all modern browsers
43
+
Sloth.css can be used as drop-in CSS library, or with a curated set of utility classes or even with a collection of handcrafted ready-to-copy-paste components. Styles are opinionated (then again: which styles are not), and crafted to prioritize visual usability over trends such as flat design. For example: Elements where you type in (like input fields) are actually inset, elements that are clickable (like buttons) are actually outstanding, tabs are connected to the content they activate etc.
Copy file name to clipboardExpand all lines: docs/pages/getting-started/installation.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ Extract the CSS files you need and include them in your markup or your bundler.
43
43
If you don’t want to use the CDN or manual download, you can install Sloth.css via npm with the following command.
44
44
45
45
```bash
46
-
npm install @devmount/sloth.css
46
+
npm i @devmount/sloth.css
47
47
```
48
48
49
-
Now you need to make one of the CSS files under `node_modules/sloth.css/` available to your app or include it in your build step.
49
+
Now you need to make one of the CSS files under `node_modules/@devmount/sloth.css/`you want available to your app or include it in your build step or bundler.
0 commit comments