Release v1.0.0

Author: mfederczuk

CHANGELOG.md

@@ -5,3 +5,12 @@
 All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2019-12-12 ##
+
+[1.0.0]: https://github.com/mfederczuk/deeptools/releases/tag/v1.0.0
+
+### Added ###
+
+* `deepCopy`, `deepEquals`, `deepFreeze` and `safeCopy` functions
+* **TypeScript** typings for all functions

README.md

@@ -1,6 +1,6 @@
 # DeepTools #
 
-[version_shield]: https://img.shields.io/badge/version-N%2FA-blue.svg
+[version_shield]: https://img.shields.io/badge/version-1.0.0-blue.svg
 [latest_release]: https://github.com/mfederczuk/deep-tools/releases/latest "Latest Release"
 [![version: N/A][version_shield]][latest_release]
 [![Changelog](https://img.shields.io/badge/-Changelog-blue)](./CHANGELOG.md "Changelog")
@@ -9,6 +9,56 @@
 
 **DeepTools** is a set of utility functions that recursively operate on objects.
 
+## Download ##
+
+Using **npm**:
+
+```sh
+npm i @mfederczuk/deeptools
+```
+
+Using **Yarn**:
+
+```sh
+yarn add @mfederczuk/deeptools
+```
+
+## Usage ##
+
+### [`deepCopy`](./src/deepCopy.js) ###
+
+```ts
+function deepCopy<T>(obj: T): T;
+```
+
+Creates a deep copy of **obj**.
+
+### [`deepEquals`](./src/deepEquals.js) ###
+
+```ts
+function deepEquals(obj1: any, obj2: any): boolean;
+```
+
+Checks if **obj1** and **obj2** are equal by recursing through their properties.
+
+### [`deepFreeze`](./src/deepFreeze.js) ###
+
+```ts
+function deepFreeze<T>(arr: T[]): ReadonlyArray<T>;
+function deepFreeze<T extends Function>(fun: T): T;
+function deepFreeze<T>(obj: T): Readonly<T>;
+```
+
+Recursively freezes **obj** with all of its properties.
+
+### [`safeCopy`](./src/safeCopy.js) ###
+
+```ts
+function safeCopy<T>(obj: T): T;
+```
+
+Creates a safe copy of **obj** by creating a deep frozen copy of it.
+
 ## Contributing ##
 
 Read through the [DeepTools Contribution Guidelines](./CONTRIBUTING.md)