Skip to content

Commit 1f01c6e

Browse files
committed
✅ 0.3.0
1 parent 1693f7b commit 1f01c6e

6 files changed

Lines changed: 34 additions & 19 deletions

File tree

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,28 @@
99
<p align="center">A drop-in utility component CSS library for lazy mammals.<br />Created by <a href="https://github.com/devmount" target="_blank">devmount</a>.</p>
1010
</p>
1111

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:
1413

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
1618

1719
## Installation
1820

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):
2028

2129
```html
2230
<link rel="stylesheet" href="https://unpkg.com/@devmount/sloth.css@^0/sloth.min.css" />
2331
```
2432

25-
If you just want to use the drop-in core styles, the utility classes or the CSS components only, you can use one of these:
33+
If you just want to use the drop-in core styles, the utility classes or the CSS components separately, you can use one of these:
2634

2735
```html
2836
<link rel="stylesheet" href="https://unpkg.com/@devmount/sloth.css@^0/sloth.core.min.css" />
@@ -32,14 +40,7 @@ If you just want to use the drop-in core styles, the utility classes or the CSS
3240

3341
## Features
3442

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.
4344

4445
## License
4546

docs/_includes/default.njk

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@
7575
<div>
7676
<div class="text-xl font-semibold">Sloth.css</div>
7777
<code class="text-muted">v{{ meta.version }}</code>
78+
<span class="text-muted text-xs">&beta;</span>
7879
</div>
7980
</div>
8081
<div class="actions">

docs/pages/getting-started/changelog.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,20 @@ tags: release version changes
88

99
Sloth.css uses [semantic versioning](https://semver.org/) to indicate breaking changes, major changes with downward compatibility or minor changes.
1010

11-
### 0.2.0-beta
11+
### v0.3.0 <span class="text-muted text-lg">β</span>
12+
13+
- ➕ Component: Badge variants ([#46](https://github.com/devmount/sloth.css/pull/46))
14+
- 📜 Docs: Secondary menu ([#47](https://github.com/devmount/sloth.css/pull/47))
15+
- ➕ Component: Input ([#48](https://github.com/devmount/sloth.css/pull/48))
16+
- 🔨 Border radius config ([#49](https://github.com/devmount/sloth.css/pull/49))
17+
- ➕ Component: Tag ([#50](https://github.com/devmount/sloth.css/pull/50))
18+
- ➕ Component: Sequence ([#51](https://github.com/devmount/sloth.css/pull/51))
19+
- ➕ Component: Tooltip ([#52](https://github.com/devmount/sloth.css/pull/52))
20+
- ➕ Component: Tab ([#53](https://github.com/devmount/sloth.css/pull/53))
21+
- ➕ Component: Modal ([#54](https://github.com/devmount/sloth.css/pull/54))
22+
- 🔨 Docs: Sidebar enhancement ([#55](https://github.com/devmount/sloth.css/pull/55))
23+
24+
### v0.2.0 <span class="text-muted text-lg">β</span>
1225

1326
- 📜 Add documentation ([#1](https://github.com/devmount/sloth.css/pull/1), [#32](https://github.com/devmount/sloth.css/pull/32), [#38](https://github.com/devmount/sloth.css/pull/38))
1427
- 🚀 Build tool ([#2](https://github.com/devmount/sloth.css/pull/2), [#15](https://github.com/devmount/sloth.css/pull/15))
@@ -28,6 +41,6 @@ Sloth.css uses [semantic versioning](https://semver.org/) to indicate breaking c
2841
- ⚡️ Performance optimizations ([#33](https://github.com/devmount/sloth.css/pull/33))
2942
- ➕ Input invalid state ([#39](https://github.com/devmount/sloth.css/pull/39))
3043

31-
### 0.1.0-beta
44+
### v0.1.0 <span class="text-muted text-lg">β</span>
3245

3346
- 🚀 Initial release

docs/pages/getting-started/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Extract the CSS files you need and include them in your markup or your bundler.
4343
If you don’t want to use the CDN or manual download, you can install Sloth.css via npm with the following command.
4444

4545
```bash
46-
npm install @devmount/sloth.css
46+
npm i @devmount/sloth.css
4747
```
4848

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.

eleventy.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import markdownit from "markdown-it";
44
import anchor from "markdown-it-anchor";
55
import tocPlugin from "eleventy-plugin-toc";
66

7-
const VERSION = '0.2.0';
7+
const VERSION = '0.3.0';
88

99
export default function (eleventyConfig) {
1010
// Get utility sections

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@devmount/sloth.css",
3-
"version": "0.2.0",
3+
"version": "0.3.0",
44
"description": "A drop-in utility component CSS-only library for lazy mammals.",
55
"main": "sloth.min.css",
66
"files": [

0 commit comments

Comments
 (0)