Skip to content

Commit

Permalink
Create DEPENDENCIES.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vanvianen committed Sep 8, 2024
1 parent d4745e6 commit f18853c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/resources/DEPENDENCIES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Dependencies

This guide describes the dependencies of this repository and their purpose.

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Package Dependencies](#package-dependencies)
- [Peer Dependencies](#peer-dependencies)
- [Development Dependencies](#development-dependencies)

## Package Dependencies

Package dependencies, or just regular dependencies are those packages that are needed for the
library code to run properly and so are are included as part of the library's final production bundle.

## Peer Dependencies

Peer dependencies are package dependencies that the library depends on
but are not included as part of the library's final production bundle.

Usually peer dependencies are packages that would-be users would already have or need
as part of their own applications, and hence, no need to include them as part of
the library code.

## Development Dependencies

Development dependencies are package dependencies used while developing library code
but are not part of the library's final production bundle.

0 comments on commit f18853c

Please sign in to comment.