Skip to content

Commit

Permalink
chore(scaffolding): update README with toc, new branch, and versions
Browse files Browse the repository at this point in the history
  • Loading branch information
jkomyno committed Oct 1, 2024
1 parent edbe906 commit d5960ee
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
# pnpm-monorepo-example

[![Github Actions](https://github.com/jkomyno/pnpm-monorepo-example/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/jkomyno/pnpm-monorepo-example/actions/workflows/ci.yaml)
[![Github Actions](https://github.com/jkomyno/pnpm-monorepo-example/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/jkomyno/pnpm-monorepo-example/actions/workflows/ci.yaml)

> Practical example of a `TypeScript` monorepo with [`pnpm`](https://pnpm.io), [`turborepo`](https://turborepo.org), and [`vitest`](https://vitest.dev/).
Tested with:
- **Node.js v20.17.0**
- **pnpm v9.11.0**
- **vitest v2.1.1**

---------------------------------------------

## Table of Contents

- [What's Included](#whats-included)
- [Available Scripts](#available-scripts)
- [Test Structure](#test-structure)
- [FAQ](#faq)
- [Author](#-author)
- [Show your support](#-show-your-support)
- [License](#-license)

## What's Included

- `pnpm` workspace, whose configuration is stored in [`pnpm-workspace.yaml`](/pnpm-workspace.yaml). Two example packages are included, [`common-utils`](packages/common-utils) and [`example`](packages/example), with the latter importing `common-utils` as a dependency. All local packages are decorated with a `@jkomyno/*` scope (you may want to substitute these instances in the `name` entries of any `package.json` with yours or your company's name).
Expand Down Expand Up @@ -55,4 +70,4 @@ Give a ⭐️ if this project helped or inspired you!
## 📝 License

Built with ❤️ by [Alberto Schiabel](https://github.com/jkomyno).<br />
This project is [MIT](https://github.com/jkomyno/pnpm-monorepo-example/blob/master/LICENSE) licensed.
This project is [MIT](https://github.com/jkomyno/pnpm-monorepo-example/blob/main/LICENSE) licensed.

0 comments on commit d5960ee

Please sign in to comment.