Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nikkilr88 committed Apr 2, 2020
1 parent 7b4e684 commit 14aa591
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## YouTube Downloader

A desktop app for downloading MP3 and MP4s from YouTube.

---

### Built With

- [Electron](https://www.electronjs.org/)
- [React](https://reactjs.org/)
- _Hooks_
- [Parcel](https://parceljs.org)

### Prerequisites

You must have the following packages installed:

- node
- yarn

### Installation

_\* Currently only available for Windows. V1.0.0 release coming soon!_

1. Clone the repo

```sh
git clone https://github.com/nikkilr88/yt-mp3-react.git
```

2. Install dependencies

```sh
yarn install
```

3. Build the project

```sh
yarn react-build
```

```sh
yarn electron-build
```

4. Navigate to `win` directory and double click the installer (`.exe` setup file)

### Screenshots

<img src="https://i.ibb.co/0VPLwxG/JGqg-RPu-Amn.gif" alt="GIF of app downloading a video">

0 comments on commit 14aa591

Please sign in to comment.