tunnckoCore/npm-related

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# [npm-related][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url] 

> Command-line app for generating a list of links to the homepages of related GitHub/npm projects. Using `helper-related`.

[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]


## Install
```
npm i npm-related --save
```


## Usage
> For more use-cases see the [tests](./test.js)

If you install it locally, just `helper-related` is exposed

```js
const npmRelated = require('npm-related')
```

## CLI
> Install it globally then run `npm-related --help` or try this one, rendered as below section

```
npm i npm-related --global
npm-related letta relike redolent

* [letta](https://www.npmjs.com/package/letta): Let's move to promises! Drop-in replacement for `co@4`, but on steroids. Accepts sync, async and generator functions. | [homepage](https://github.com/hybridables/letta)
* [redolent](https://www.npmjs.com/package/redolent): Simple promisify **everything** (string, array, stream, boolean, sync/async function, etc) with sane defaults. | [homepage](https://github.com/hybridables/redolent)
* [relike](https://www.npmjs.com/package/relike): Simple promisify a callback-style function with sane defaults. Support promisify-ing sync functions. | [homepage](https://github.com/hybridables/relike)
```


## Related
* [letta](https://github.com/hybridables/letta): Let's move to promises! Drop-in replacement for `co@4`, but on steroids. Accepts sync, async and generator functions.
* [redolent](https://github.com/hybridables/redolent): Simple promisify **everything** (string, array, stream, boolean, sync/async function, etc) with sane defaults.
* [relike](https://github.com/hybridables/relike): Simple promisify a callback-style function with sane defaults. Support promisify-ing sync functions.
* [apidocs-cli](https://github.com/tunnckocore/apidocs-cli): Command-line app for generating API docs from code comments. Using `helper-apidocs`.
* [helper-apidocs](https://github.com/jonschlinkert/helper-apidocs): Template helper for automatically generating API docs from code comments.
* [helper-related](https://github.com/helpers/helper-related): Template helper for generating a list of links to the homepages of related GitHub/npm projects.
* [parse-function](https://github.com/tunnckocore/parse-function): Parse a function, arrow function or string to object with name, args, params and body properties.


## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/npm-related/issues/new).  
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.


## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]

[![tunnckocore.tk][author-www-img]][author-www-url] [![keybase tunnckocore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]


[npmjs-url]: https://www.npmjs.com/package/npm-related
[npmjs-img]: https://img.shields.io/npm/v/npm-related.svg?label=npm-related

[license-url]: https://github.com/tunnckoCore/npm-related/blob/master/LICENSE
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg


[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/npm-related
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/npm-related.svg

[travis-url]: https://travis-ci.org/tunnckoCore/npm-related
[travis-img]: https://img.shields.io/travis/tunnckoCore/npm-related.svg

[coveralls-url]: https://coveralls.io/r/tunnckoCore/npm-related
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/npm-related.svg

[david-url]: https://david-dm.org/tunnckoCore/npm-related
[david-img]: https://img.shields.io/david/tunnckoCore/npm-related.svg

[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg


[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg

[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg

[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg

[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg

[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg

[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg

[new-message-url]: https://github.com/tunnckoCore/ama
[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg