https://github.com/shidhincr/npm-module

Quick and easy way to create an npm module. Clone, Edit and Publish
https://github.com/shidhincr/npm-module

node-module npm yarn-packages

Last synced: 3 days ago
JSON representation

Quick and easy way to create an npm module. Clone, Edit and Publish

• Host: GitHub
• URL: https://github.com/shidhincr/npm-module
• Owner: shidhincr
• Created: 2017-05-01T14:59:41.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-05-02T08:01:13.000Z (over 7 years ago)
• Last Synced: 2024-11-05T18:55:49.086Z (about 2 months ago)
• Topics: node-module, npm, yarn-packages
• Language: JavaScript
• Homepage:
• Size: 76.2 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
NAME OF YOUR MODULE




> 👬 Tell something about your npm-module here. With emojis  🙌



[![Build Status](https://travis-ci.org/namshi/dollar-dom.svg?branch=master)](https://travis-ci.org/namshi/dollar-dom)

[![Open Source Namshi](https://img.shields.io/badge/open--source-Namshi-blue.svg)](https://github.com/namshi)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)



## Why

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

## Install

using **npm**

    npm install --save package-name

using **yarn**

    yarn add package-name

If you're using module bundlers like webpack, Browserify or rollup, you can import `greet` from **package-name** module:

```js

import {greet} from 'package-name';

// or

const {greet} = require('package-name');

```

If you wish to include as a script, **package-name** can be included like this:

    

and will be available as a global object named **`packageName`** in the browser.

## API and Examples

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

## Want to Contribute ?

We love contributions from everyone. 

  1. Fork the repo.

  2. Install dependencies. `yarn install` or `npm install`

  3. We use `AVA` for unit tests. 

      - To run unit tests, `yarn test` or `npm test`

      - To run unit test in --watch mode, `yarn test-watch` or `npm run test-watch`

  4. Implement the changes, and write test cases. Make sure that all unit test pass.

  5. To generate the final build, run `yarn build` or `npm build`.

  6. Push your code and create a Pull Request

      

## Release and publish to NPM

*__Note:__ Make sure you're logged in to NPM before doing this.*

To create a tag and publish to NPM run `npm run release` or `yarn release`. This will show an interactive session on terminal, where you can choose the semantic version to publish. After that, the github `release` page will be opened for adding the change logs.

## Licence

MIT @ [YourCompany.com](www.yourcompany.com)