From c7a5c0979dd4ab917d8209aed5168253cadec4e6 Mon Sep 17 00:00:00 2001 From: Alex Taylor Date: Sat, 5 May 2018 19:56:06 -0700 Subject: [PATCH] Update README and LICENSE --- LICENSE | 2 +- README.md | 18 +++++++++++++----- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/LICENSE b/LICENSE index d5e7a67..699d5c5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (C) 2017 Alex Taylor +Copyright (C) 2018 Alex Taylor Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), diff --git a/README.md b/README.md index f37cdce..c620ce3 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,21 @@ [![Build Status](https://travis-ci.org/subnomo/tubetop.svg?branch=master)](https://travis-ci.org/subnomo/tubetop) [![Coverage Status](https://coveralls.io/repos/github/subnomo/tubetop/badge.svg?branch=master)](https://coveralls.io/github/subnomo/tubetop?branch=master) -A YouTube music player, for your desktop. +![screen](https://i.imgur.com/9E7LFVA.png) + +**tubetop is a YouTube music player built with [Electron](https://electronjs.org/), [React](https://reactjs.org/), and [Redux](https://redux.js.org/) and written in [TypeScript](https://www.typescriptlang.org/).** + +## Download +Check out the [releases page](https://github.com/subnomo/tubetop/releases) to download the latest release for your platform. -Development setup: +## Development +To get started you'll need: +* Node.js +* Yarn + +Then run: ``` $ yarn install -$ node fuse +$ yarn start ``` - -![screen](https://i.imgur.com/9E7LFVA.png)