docs: improve docs with bytes unit and introduction

README.md

@@ -4,10 +4,22 @@
 [![check-disk-space on npm](https://img.shields.io/npm/v/check-disk-space?style=for-the-badge)](https://www.npmjs.com/package/check-disk-space)
 [![License MIT](https://img.shields.io/github/license/Alex-D/check-disk-space.svg?style=for-the-badge)](LICENSE)
 
+
+## Introduction
+
+Light multi-platform disk space checker without third party for Node.js.
+
+- Works on Linux, macOS and Windows
+- Take care of mounting points on unix-like systems
+- No dependencies
+- TypeScript support
+
+
 ## Install
 
 `npm install check-disk-space`
 
+
 ## Usage
 
 ```js
@@ -25,6 +37,7 @@ checkDiskSpace('C:/blabla/bla').then((diskSpace) => {
     //     free: 12345678,
     //     size: 98756432
     // }
+    // Note: `free` and `size` are in bytes
 })
 
 // On Linux or macOS
@@ -35,5 +48,6 @@ checkDiskSpace('/mnt/mygames').then((diskSpace) => {
     //     free: 12345678,
     //     size: 98756432
     // }
+    // Note: `free` and `size` are in bytes
 })
 ```

src/errors/invalidPathError.ts

@@ -1,6 +1,3 @@
-/**
- * @public
- */
 class InvalidPathError extends Error {
 	name = 'InvalidPathError'
 

src/errors/noMatchError.ts

@@ -1,6 +1,3 @@
-/**
- * @public
- */
 class NoMatchError extends Error {
 	name = 'NoMatchError'
 

src/functions/getFirstExistingParentPath.ts

@@ -2,7 +2,6 @@ import Dependencies from '@/src/types/dependencies'
 
 /**
  * Get the first existing parent path
- * @public
  *
  * @param directoryPath - The file/folder path from where we want to know disk space
  * @param dependencies - Dependencies container

src/index.ts

@@ -10,7 +10,6 @@ import DiskSpace from '@/src/types/diskSpace'
 
 /**
  * Check disk space
- * @public
  *
  * @param directoryPath - The file/folder path from where we want to know disk space
  * @param dependencies - Dependencies container

src/types/dependencies.ts

@@ -2,9 +2,6 @@ import {ChildProcess, ExecFileException} from 'child_process'
 import {existsSync} from 'fs'
 import {normalize, sep} from 'path'
 
-/**
- * @public
- */
 type Dependencies = {
 	platform: NodeJS.Platform
 	fsExistsSync: typeof existsSync

src/types/diskSpace.ts

@@ -1,5 +1,5 @@
 /**
- * @public
+ * `free` and `size` are in bytes
  */
 type DiskSpace = {
 	diskPath: string