https://github.com/fkanout/medium-read-cli

Read Medium's stories from your lovely, colored, customized... terminal. No need for browsers anymore !
https://github.com/fkanout/medium-read-cli

cli medium-api nodejs terminal

Last synced: 8 months ago
JSON representation

Read Medium's stories from your lovely, colored, customized... terminal. No need for browsers anymore !

• Host: GitHub
• URL: https://github.com/fkanout/medium-read-cli
• Owner: fkanout
• License: mit
• Created: 2017-08-05T21:55:39.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-05-13T16:51:41.000Z (almost 8 years ago)
• Last Synced: 2025-03-23T04:46:01.495Z (about 1 year ago)
• Topics: cli, medium-api, nodejs, terminal
• Language: JavaScript
• Homepage:
• Size: 36.4 MB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![alt text](https://raw.githubusercontent.com/fkanout/medium-read-cli/master/assets/mdm200.png)

[![NPM](https://nodei.co/npm/medium-read-cli.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/medium-read-cli/)

[![npm](https://img.shields.io/npm/v/medium-read-cli.svg)]()

[![npm](https://img.shields.io/npm/dw/medium-read-cli.svg)]()

[![npm](https://img.shields.io/npm/dm/medium-read-cli.svg)]()

[![npm](https://img.shields.io/npm/dy/medium-read-cli.svg)]()

[![npm](https://img.shields.io/npm/l/medium-read-cli.svg)]()

[![Maintainability](https://api.codeclimate.com/v1/badges/14936011564f37d067c1/maintainability)](https://codeclimate.com/github/fkanout/medium-read-cli/maintainability)

# medium-read-cli

Read [Medium's](https://www.medium.com) stories from your *lovely, colored, customized...* terminal. No need for browsers anymore !

> 🔥New🔥  Now you can see the stories images and code snippets from your terminal! 

![alt text](https://raw.githubusercontent.com/fkanout/medium-read-cli/addImgArticle/assets/demoWithImg.gif)

# Why

I'm a big fan of [Medium](https://www.medium.com), and I enjoy spending time reading stories. So I thought as a developer it could be a nicer reading experience from a terminal, **far from any browsers' distractions**.

# How to install

It's recommended to install it globaly on your machine, so you can read the stories anywhere anytime !

`npm install -g medium-read-cli`

Then run:

`mdm`

and voila, happy reading !

# How to use

it's very easy you only need a few keys:

`ENTER`: Pick to read a story

`SPACE`: Get more stories

`↑` `↓`: Navigate between the stories' list

`⇐`: *backsapce* Back to stories' list once finished reading a story

`ESC`: Exit

# Yet to come

- Improvements 

- Read by topics

- ...

For any suggestion please [email me](mailto:faisal@kanout.com).

# Who am I

[Website](https://www.kanout.com)

[Linkedin](https://www.linkedin.com/in/faisalkanout/)