build(js-utils):v2.0.0

Author: IbenTesara

libs/javascript/utils/README.md

@@ -1,55 +1,25 @@
-# Utilities (`@studiohyperdrive/utils`)
+# Javascript Tools: Utils (`@studiohyperdrive/utils`)
+
+`@studiohyperdrive/utils` is a set of common Javascript based utils.
+
+## Installation
 
 Install the package first:
+
 ```shell
 npm install @studiohyperdrive/utils
 ```
 
-## 1. Object
-
-A set of Object based helpers.
-
-### getKeyByValue
-The getKeyByValue helper function will search for a key within an object, based on the provided value.
-
-[Full documentation.](./docs/object/get-key-by-value/get-key-by-value.util.md)
-
-### merge
-Merges all arguments into a single object, as long as the property has a value.
-
-[Full documentation.](./docs/object/merge/merge.util.md)
-
-## 2. String
-
-A set of String based helpers.
-
-### camelCaseToSentence
-Converts a camelCase string to a human-readable sentence.
-
-[Full documentation.](./docs/string/camel-case-to-sentence/camel-case-to-sentence.util.md)
-
-### replaceHtmlWhitespace
-Returns the filtered html as a string that has replaced the non-breakable whitespaces with regular spaces.
-
-[Full documentation.](./docs/string/replace-whitespace/replace-whitespace.util.md)
-
-### stringComparator
-Compares two strings alphabetically using localeCompare.
-
-[Full documentation.](./docs/string/string-comparator/string-comparator.util.md)
+## Versioning and build information
 
-## build information
-This project has been build with:
-- nodejs: `18.17.0`
-- npm: `9.6.7`
+This package will follow a semver-like format, `major.minor.patch`, in which:
 
-For a complete list of packages and version check out the `package.json` file.
+-   `major`: Introduces new features or breaking changes
+-   `minor`: Introduces minor non-breaking changes
+-   `patch`: Introduces bugfixes 
 
-## Team
+For more information about the build process, authors, contributions and issues, we refer to the [hyperdrive-opensource](https://github.com/studiohyperdrive/hyperdrive-opensource) repository.
 
-This bundle of tools has been created and is maintained by [Studio Hyperdrive](https://studiohyperdrive.be).
+## Documentation
 
-Contributors:
-- [Denis Valcke](https://github.com/DenisValcke)
-- [Iben Van de Veire](https://github.com/IbenTesara)
-- [Wouter Heirstrate](https://github.com/WHeirstrate)
+To find more information regarding this package, we refer to [our documentation platform](https://open-source.studiohyperdrive.be/docs/javascript/utils/introduction).

libs/javascript/utils/docs/object/get-key-by-value/get-key-by-value.util.md

@@ -1,14 +1,40 @@
 {
-	"name": "@studiohyperdrive/utils",
-	"version": "1.0.2",
-	"license": "MIT",
-	"main": "./index.js",
-	"module": "./index.mjs",
-	"typings": "./index.d.ts",
-	"peerDependencies": {
-		"obj-clean": "^3.0.1",
-		"vite": "5.4.11",
-		"@nx/vite": "20.2.1",
-		"vite-plugin-dts": "4.3.0"
-	}
-}
+  "name": "@studiohyperdrive/utils",
+  "version": "2.0.0",
+  "description": "A package containing common Javascript utils.",
+  "keywords": [
+    "file",
+    "number",
+    "object",
+    "string",
+    "range",
+    "get-key-by-value",
+    "merge",
+    "search-recursively",
+    "camel-case-to-sentence",
+    "normalize-string",
+    "replace-whitespace",
+    "search-string",
+    "string-comparator"
+  ],
+  "homepage": "https://open-source.studiohyperdrive.be/docs/javascript/utils/introduction",
+  "author": {
+    "name": "Studio Hyperdrive",
+    "url": "https://studiohyperdrive.be/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/studiohyperdrive/hyperdrive-opensource",
+    "directory": "libs/javascript/rxjs/src"
+  },
+  "license": "MIT",
+  "main": "./index.js",
+  "module": "./index.mjs",
+  "typings": "./index.d.ts",
+  "peerDependencies": {
+    "obj-clean": "^3.0.1",
+    "vite": "5.4.11",
+    "@nx/vite": "20.2.1",
+    "vite-plugin-dts": "4.3.0"
+  }
+}