docs: update md files

Author: Sv443

CHANGELOG.md

@@ -1,11 +1,22 @@
+# @sv443-network/coreutils
+
+## 1.0.0
+
+This is the initial release of CoreUtils. Most features have been originally ported from [version 9.4.1 of `@sv443-network/userutils`](https://github.com/Sv443-Network/UserUtils/tree/v9.4.1)  
+Parts of the code have been overhauled, and some features have been added:
 - Additions:
-  - array:
-    - Added `takeRandomItemIndex()`
-- BREAKING CHANGES:
+  - Added [`capitalize()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-capitalize) to capitalize the first letter of a string.
+  - Added [`setImmediateInterval()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-setimmediateinterval) to set an interval that runs immediately, then again on a fixed *interval.*
+  - Added [`setImmediateTimeoutLoop()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-setimmediatetimeoutloop) to set a recursive `setTimeout()` loop with a fixed *delay.*
+  - Added [`takeRandomItemIndex()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-takerandomitemindex), as a mutating counterpart to [`randomItemIndex()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-randomitemindex)
+  - Added [`truncStr()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-truncstr) to truncate a string to a given length, optionally adding an ellipsis.
+  - Added [`valsWithin()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-valswithin) to check if two values, rounded at the given decimal, are within a certain range of each other.
+- **BREAKING CHANGES:**
   - Reworked DataStore
-    - Encoding with `deflate-raw` will now be enabled by default. Set `compressionFormat: null` to disable it.
-    - Added `DataStoreEngine` base class to create a persistent storage engine
-    - Added `FileStorageEngine` for file-based storage in the backend and `BrowserStorageEngine` for browser API based storage
-    - The global key `__ds_fmt_ver` will now contain a global version number for DataStore-internal format integrity
-  - crypto:
-    - renamed `ab2str()` to `abtoa()` and `str2ab()` to `atoab()` to match `btoa()` and `atob()`
+    - The constructor now needs an `engine` property that is an instance of a [`DataStoreEngine`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-datastoreengine.)
+    - Encoding with `deflate-raw` will now be enabled by default. Set `compressionFormat: null` to disable it and restore the previous behavior.
+    - Added [`DataStoreEngine` class](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-datastoreengine) with two implementations available out-of-the-box; [`FileStorageEngine`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-filestorageengine) and [`BrowserStorageEngine`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-browserstorageengine), for Node/Deno and browser environments respectively. Userscripts need to use [`BrowserStorageEngine`.](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-browserstorageengine)
+    - Added shorthand property `compressionFormat` as an alternative to the properties `encodeData` and `decodeData`
+    - The global key `__ds_fmt_ver` will now contain a global version number for DataStore-internal format integrity.
+  - Renamed `ab2str()` to `abtoa()` and `str2ab()` to `atoab()` to match `btoa()` and `atob()`
+  - Renamed `purifyObj()` to `pureObj()`

README.md

@@ -1,15 +1,10 @@
-> [!IMPORTANT]  
-> This library is not ready to be used yet. Please check back in a couple weeks.
-
-<br><br>
-
 <div align="center" style="text-align: center;">
 
 # CoreUtils
 Cross-platform, general-purpose, JavaScript core library for Node, Deno and the browser.  
 Intended to be used in conjunction with [`@sv443-network/userutils`](https://github.com/Sv443-Network/UserUtils) and [`@sv443-network/djsutils`](https://github.com/Sv443-Network/DJSUtils), but can be used independently as well.
 
-### [Documentation](./docs.md#readme) &bull; [Features](#features) &bull; [Installation](#installation) &bull; [License](#license)
+### [Documentation](./docs.md#readme) &bull; [Features](#features) &bull; [Installation](#installation) &bull; [License](#license) &bull; [Changelog](./CHANGELOG.md)
 
 </div>
 <br>
@@ -138,4 +133,35 @@ pnpm i @sv443-network/coreutils
 yarn add @sv443-network/coreutils
 npx jsr install @sv443-network/coreutils
 deno add jsr:@sv443-network/coreutils
-```
+```
+- If you are in a DOM environment, you can include the UMD bundle using your favorite CDN:
+```html
+<script src="https://cdn.jsdelivr.net/npm/@sv443-network/coreutils@latest/dist/CoreUtils.min.umd.js"></script>
+<script src="https://unpkg.com/@sv443-network/coreutils@latest/dist/CoreUtils.min.umd.js"></script>
+<script src="https://esm.sh/@sv443-network/coreutils@latest/dist/CoreUtils.min.umd.js"></script>
+```
+- Then, import parts of the library as needed:
+```ts
+// >> EcmaScript Modules (ESM):
+
+// - import parts of the library:
+import { randomItem } from "@sv443-network/coreutils";
+// - or import the full library:
+import * as CoreUtils from "@sv443-network/coreutils";
+// - or import raw TS files, after installing via JSR:
+import { DataStore } from "jsr:@sv443-network/coreutils/lib/DataStore.ts";
+
+// >> CommonJS (CJS):
+
+// - import parts of the library:
+const { debounce } = require("@sv443-network/coreutils");
+// - or import the full library:
+const CoreUtils = require("@sv443-network/coreutils");
+
+// >> Universal Module Definition (UMD):
+
+// - to make the global variable `CoreUtils` available, import this file:
+// "@sv443-network/coreutils/dist/CoreUtils.min.umd.js"
+// - or import the library on your HTML page:
+// <script src="https://cdn.jsdelivr.net/npm/@sv443-network/coreutils@latest/dist/CoreUtils.min.umd.js"></script>
+```

docs.md

@@ -1399,7 +1399,7 @@ const engine = new FileStorageEngine(options?: FileStorageEngineOptions);
   
 Storage engine for the [`DataStore` class](#class-datastore) that uses a file to store data.  
   
-⚠️ Requires Node.js or Deno with Node compatibility  
+⚠️ Requires Node.js or Deno with Node compatibility (v1.31+)  
 ⚠️ Don't reuse this engine across multiple [`DataStore`](#class-datastore) instances  
   
 <details><summary>Example - click to view</summary>

jsr.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://jsr.io/schema/config-file.v1.json",
   "name": "@sv443-network/coreutils",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "exports": {
     ".": "./lib/index.ts"
   },