https://github.com/barrel/base-npm-package
Quickly development and publish a javascript package with this scaffold
https://github.com/barrel/base-npm-package
Last synced: 17 days ago
JSON representation
Quickly development and publish a javascript package with this scaffold
- Host: GitHub
- URL: https://github.com/barrel/base-npm-package
- Owner: barrel
- Created: 2016-09-27T14:40:26.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-29T13:10:28.000Z (almost 10 years ago)
- Last Synced: 2025-01-08T04:39:14.131Z (over 1 year ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
##Description
*Insert a short description explaining the purpose of the package*
## Install
```bash
npm i {{package-name}} --save
```
## Basic Usage
```javascript
import {{identifier}} from '{{package-name}}'
//Show examples of how a consumer can instantiate or interact with the package
```
## Configuration
```javascript
//Explain how the package can be configured.
//If the package follows a constructor pattern, what arguments does it accept?
//Are there any default values to the arguments that need explaining?
```
## API: Methods
```javascript
//What methods can a consumer call to interact with the package?
```
## API: Properties
```javascript
//What properties can a consumer access to ascertain the state of the package?
```
## Styling
```css
.package-name{
/* Are there any styles needed to support the package? */
}
```
## Markup
```html
```
## Contributing
*How can a developer add contributions to the package?*
## License