https://github.com/kpman/newsroom

💻 A modern CLI to get your favorite news. 📰
https://github.com/kpman/newsroom

Last synced: 3 days ago
JSON representation

💻 A modern CLI to get your favorite news. 📰

• Host: GitHub
• URL: https://github.com/kpman/newsroom
• Owner: kpman
• License: mit
• Created: 2017-10-31T16:19:21.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-10-19T01:23:22.000Z (about 1 year ago)
• Last Synced: 2024-11-09T18:25:24.060Z (11 days ago)
• Language: TypeScript
• Homepage: https://npmjs.com/newsroom-cli
• Size: 1.26 MB
• Stars: 124
• Watchers: 3
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



  


	

	


  




> 💻 A modern CLI to get your favorite news. 📰

[![npm version](https://img.shields.io/npm/v/newsroom-cli.svg?style=flat)](https://www.npmjs.com/package/newsroom-cli) [![Build Status](https://img.shields.io/travis/kpman/newsroom.svg?branch=master)](https://travis-ci.org/kpman/newsroom) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](#contributing)

## Install

```shell

npm install -g newsroom-cli

```

The CLI will register `newsroom` and `nr` in your shell.

## Usage

```shell

$ newsroom

```

![](https://user-images.githubusercontent.com/2382594/33028798-c8a6fb7c-ce51-11e7-98ae-671c1136bbcf.gif)

or with your own awesome [OPML](http://dev.opml.org/) file

```shell

$ newsroom -o 

```

![](https://user-images.githubusercontent.com/2382594/32977243-606733d6-cc64-11e7-8f2e-8df4058bbdc8.gif)

You will enter a interactive command line interface.

Type the source you want to receive and press enter.

```shell

$ newsroom [source] [number]

```

You can see the latest news from source.



## Help

```shell

$ newsroom --help

```

## Contributing

### Make the change

- Modify the source code in `src` folder.

- Run `npm run test` from the project root. Make sure it pass the check.

### Push it

- Make a Pull-request directly on `master` branch

## Related Repos

- [haxor-news](https://github.com/donnemartin/haxor-news)

## Maintainers

- [Daniel Tseng](https://github.com/kpman)

- Waiting for you 🤘

## License

MIT