Skip to content

Commit f7d6d6a

Browse files
committed
chore: prepare 3.0.1 release
1 parent 6c3bc39 commit f7d6d6a

4 files changed

Lines changed: 15 additions & 38 deletions

File tree

.github/workflows/ci.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ on:
44
push:
55
branches:
66
- main
7+
paths-ignore:
8+
- "**/*.md"
79
pull_request:
10+
paths-ignore:
11+
- "**/*.md"
812

913
jobs:
1014
test:

README.md

Lines changed: 3 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,14 @@
66
[![minzipped size](https://img.shields.io/bundlejs/size/%40fr0st/core?format=minzip&style=flat-square)](https://bundlejs.com/?q=@fr0st/core)
77
[![license](https://img.shields.io/github/license/elusivecodes/FrostCore?style=flat-square)](./LICENSE)
88

9-
Small, focused JavaScript utilities for arrays, functions, math, objects, strings, and type checks.
10-
11-
FrostCore is an ESM-first utility library with zero runtime dependencies. It works in Node and bundlers, and it also ships a browser-friendly UMD bundle that exposes `globalThis._`.
9+
Small, focused ESM utilities for arrays, functions, math, objects, strings, and type checks. FrostCore has zero runtime dependencies, works in Node and bundlers, and also ships a browser-friendly UMD bundle that exposes `globalThis._`.
1210

1311
## Highlights
1412

1513
- Named exports for tree-shaking
1614
- Browser UMD bundle in `dist/`
1715
- No runtime dependencies
1816
- JSDoc-powered IntelliSense
19-
- Utility coverage across arrays, objects, strings, math, functions, and type checks
2017

2118
## Installation
2219

@@ -30,19 +27,11 @@ FrostCore is ESM-only. Use `import` syntax in Node and bundlers.
3027

3128
### Browser (UMD)
3229

33-
Load the bundle from your own copy:
30+
Load the bundle from your own copy or a CDN:
3431

3532
```html
3633
<script src="/path/to/dist/frost-core.min.js"></script>
37-
<script>
38-
const { clamp, randomInt } = globalThis._;
39-
console.log(clamp(randomInt(10), 0, 9));
40-
</script>
41-
```
42-
43-
Or load it from a CDN:
44-
45-
```html
34+
<!-- or -->
4635
<script src="https://cdn.jsdelivr.net/npm/@fr0st/core@latest/dist/frost-core.min.js"></script>
4736
<script>
4837
const { clamp, randomInt } = globalThis._;
@@ -76,22 +65,6 @@ console.log(clamp(14, 0, 10)); // 10
7665
save();
7766
```
7867

79-
## Usage
80-
81-
Recommended:
82-
83-
```js
84-
import { debounce, throttle } from '@fr0st/core';
85-
```
86-
87-
Namespace import:
88-
89-
```js
90-
import * as _ from '@fr0st/core';
91-
92-
_.range(0, 3); // [0, 1, 2, 3]
93-
```
94-
9568
TypeScript note: FrostCore is written in JavaScript and uses JSDoc types, which most editors surface as IntelliSense.
9669

9770
## API

package-lock.json

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@fr0st/core",
3-
"version": "3.0.0",
3+
"version": "3.0.1",
44
"description": "FrostCore is a free, open-source utility library for JavaScript.",
55
"keywords": [
66
"utility",
@@ -42,7 +42,7 @@
4242
"access": "public"
4343
},
4444
"devDependencies": {
45-
"@fr0st/eslint-config": "^2.0.1",
45+
"@fr0st/eslint-config": "^2.0.2",
4646
"eslint": "^10.0.3",
4747
"mocha": "^11.7.5",
4848
"rollup": "^4.59.0",

0 commit comments

Comments
 (0)