Add README.md (#58)

Author: drebrez

CHANGELOG.md

@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Code coverage with 100% threshold
+- README.md
 
 ## [1.2.0] - 2025-01-13
 

README.md

@@ -0,0 +1,22 @@
+# javascript-utils
+
+This is a collection of utilities that we have created to help with our development process. We have decided to open source these utilities in the hopes that they will be useful to others.
+
+## Usage
+
+To use these utilities, simply add the [@neolution-ch/javascript-utils](https://www.npmjs.com/package/@neolution-ch/javascript-utils) npm package to your project and use the desired functions in your source code.
+
+## Contributing
+
+If you would like to contribute to this project, please submit a pull request.
+
+### Guidelines
+
+- Use a filename that fits what the utility is doing. If you introduce a new file, choose a name that fits your utility but is still generic enough to hold similar utilities that can be added later alongside your addition.
+- Add tests to your utilities and strive to cover many different usage scenarios and parametrization and high code coverage.
+
+## Releases
+
+Due to the nature of this project as a loosely connected collection of utilities, it's important to be strict about following [SemVer](https://semver.org/) to communicate possible breaking changes to the users of this library via version number.
+
+Equally as important is to be precise about the changes made in each release and maintain the [CHANGELOG.md](CHANGELOG.md) according to the [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format so users of this library can see easily where changes were made.