https://github.com/freckle/npm-package-template
Template repository for a package in npm
https://github.com/freckle/npm-package-template
ghvm-managed
Last synced: 8 months ago
JSON representation
Template repository for a package in npm
- Host: GitHub
- URL: https://github.com/freckle/npm-package-template
- Owner: freckle
- License: mit
- Created: 2023-03-10T00:53:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-11T00:15:25.000Z (over 1 year ago)
- Last Synced: 2025-02-11T01:22:35.688Z (over 1 year ago)
- Topics: ghvm-managed
- Language: JavaScript
- Homepage:
- Size: 1.23 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# npm Package Template
Our custom template repository for creating a package published to npm.
[Creating a repository from a template][docs].
(If you are working within Freckle, use [github-vending-machine](https://github.com/freckle/github-vending-machine) instead)
[docs]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template
**NOTE**: Be sure to look for strings like "TODO", "Package name", or "package-name" and update
them accordingly.
## Install
```sh
yarn add package-name
```
## Usage
### process(input)
TODO: Document public API for package.
## Versioning and release process
See [RELEASE.md](./RELEASE.md).
---
[LICENSE](./LICENSE)