From 22ecc4bf72bebb6d9ab8ed41263bc543a273206e Mon Sep 17 00:00:00 2001 From: Jon Scheiding Date: Mon, 6 May 2019 11:09:15 -0400 Subject: [PATCH] README updates --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f3f2121..506b60e 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,22 @@ This repository implements a tool that can be used to generate a usable e-book version of the 2019 "Report On The Investigation Into Russian Interference In The 2016 Presidential Election". The book is generated in MOBI format for Kindles, and EPUB for other e-readers. -### Acknowledgement +I created this because I think every American should read this report, and I wanted to do my part to make that as easy as possible. + +## Acknowledgement This would not have been possible without the hard work of the New York Times transcribing the report. Their version can be found [here](https://www.nytimes.com/interactive/2019/04/18/us/politics/mueller-report-document.html), and includes a lot of helpful annotations as well as an "Explore By Person" index. -## Installation +In respect for the work they put in, I've included their annotations in the generated e-book. + +## Download To download the final e-book, go to the [latest release](https://github.com/jonscheiding/mueller-report-ebook-generator/releases/latest) page. -### Installation for Kindle +### Download for Kindle -1. Download `mueller-ebook.mobi` from the latest release page. +1. Download `mueller-ebook.mobi` from the [latest release](https://github.com/jonscheiding/mueller-report-ebook-generator/releases/latest) page. 2. Plug your Kindle in to your computer. It should show up as an external drive. 3. Copy `mueller-ebook.mobi` into the `documents` folder on your Kindle drive. Feel free to contribute instructions for other e-readers. - -## Development - -Clone the repository and run `yarn` to install dependencies. - -- To build the e-book, run `yarn build`. -- To make changes, run `yarn start` and then browse to http://localhost:5000. -