Coder Social home page Coder Social logo

mmm-piratespeaknews's Introduction

MMM-PirateSpeakNews

MM2 News Module, translated to pirate speak.

News articles with pictures and brief description, translated to pirate speak.

First go to:

https://newsapi.org/ and get your free api key... free and easy!!

Installation

Setup the MagicMirror module

~MagicMirror/modules

git clone https://github.com/buzzkc/MMM-PirateSpeakNews.git

cd MMM-PirateSpeakNews

npm install

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

{
    module: 'MMM-PirateSpeakNews',
	position: 'bottom_bar',
	config: {
		key: "xxxxxxxxxxxxxxxxxxxxxxxx",
		maxWidth: "100%",
	    newsSource: "hacker-news"
    }
},

Configuration options

Option Description
moduleWidth Optional can use px or %.... the above configuration would be used for bottom_bar location. Example top_left or top_right - 250px;
newsSource Required default news source: "usa-today"
key Required go to: https://newsapi.org/ and get your free api key... free and easy!!

List of possible sources:

"the-next-web" "time" "usa-today" "the-washington-post" "the-wall-street-journal" "the-verge" "the-times-of-india" "the-sport-bible" "the-new-york-times" "the-lad-bible" "the-huffington-post" "the-hindu "the-guardian-uk "the-guardian-au "techradar "techcrunch "talksport" "sky-sports-news" "reuters" "reddit-r-all" "recode" "polygon" "nfl-news" "newsweek" "new-scientist" "national-geographic" "mtv-news-uk" "mtv-news" "mirror" "metro" "mashable" "ign" "hacker-news" "google-news" "fox-sports" "four-four-two" "fortune" "football-italia" "financial-times"

Must be entered in your config.js just as shown!

Thanks To

mmm-piratespeaknews's People

Contributors

hestela avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.