Skip to content

Commit 19b09aa

Browse files
authored
Update README about published guide and maintainers (#19)
* Update README about published guide and maintainers * fixup! Update README about published guide and maintainers
1 parent 9979083 commit 19b09aa

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Node.js package shipping patterns
22

3-
> [!NOTE]
4-
> This repository is currently under construction. It's meant to replace the sections in the Node.js package documentation for documenting package shipping patterns, the pros and cons, and guidelines for CJS to ESM migration.
3+
This project is meant to document common package shipping patterns, the pros and cons, and guidelines for CJS to ESM migration.
54

6-
A team is being formed to get this effort up and going! See [Issue #3](https://github.com/nodejs/package-examples/issues/3) for details.
5+
The guide on package configuration is published at <https://nodejs.github.io/package-examples/>. Source document and examples are in the [guide/](./guide/) directory.
76

8-
⚒️ The package shipping guide is being worked on [here](./guide/) . See [contribution guide](./CONTRIBUTING.md) on how to contribute to it.
9-
For a quick overview of what the guide covers, see [guide/SUMMARY.md](./guide/SUMMARY.md).
7+
This guide is still in early stages. Contributions are welcome! See [contribution guide](./CONTRIBUTING.md) on how to contribute to this project.
8+
9+
The following teams have maintainer access to this repository:
10+
11+
- [Node.js Package Maintenance Team](https://github.com/orgs/nodejs/teams/package-maintenance)
12+
- [Node.js Package Pathfinders Team](https://github.com/orgs/nodejs/teams/package-pathfinders)
13+
- [Node.js Loaders Team](https://github.com/orgs/nodejs/teams/loaders)
1014

1115
The previous documents from package.md in the Node.js API documentation have been moved to [this chapter](./guide/07-dual-packages/README.md) for reference.

0 commit comments

Comments
 (0)