tell-about

KO | EN

gitlite — search

#python #react #ai #typescript #golang #android #rust #deep-learning #macos #java #cli #vue #security #openai

(★ 26)

A CLI Tool that help you know about npm pacakges right in the command line.

tell-about Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/yashguptaz/tell-about.svg?branch=master)](https://travis-ci.org/yashguptaz/tell-about)
[![codecov](https://codecov.io/gh/yashguptaz/tell-about/branch/master/graph/badge.svg)](https://codecov.io/gh/yashguptaz/tell-about)

# tell-about

**tell-about** is a npm package that provides you with useful information about any npm package you want.

You can use it to quickly know the GitHub repo and Website of the package and visit it right through your terminal.

You can use it to quickly know when was the last commit in the package's repo and how many issues there are present, allowing you to quickly judge how good the project is.

And there are many other things that an also be done.

## Table of Contents

- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)

## Prerequisites

1. npm v5.2.0 or above installed.

## Usage

1. Type the command below in your terminal -

``` npx tell-about <package_name>``` 
   Replace package name with the name of the package you want to know about.

*Note: If you just run `npx tell-about` it will prompt you to enter the package's name, but it takes a keystroke more so it is not recommended to do that regularly.*

## Contributing

Development of tell-about happens in the open on GitHub, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving tell-about.

We have a publicly available [roadmap](https://www.notion.so/409bc8f606b740b4abc5eb3bcbd549df?v=51de545d10bb464291bc56e4dc30fc85) which you can refer to and know what to expect from us in future.

### [Code of Conduct](./CODE_OF_CONDUCT.md)

tell-about has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

### Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/organization--or-user/repo-name/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.

### License

tell-about is [MIT licensed](./LICENSE).

tell-about

tell-about Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

tell-about

tell-about Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README