From 58504253f0b17f9b1cf1b2d577434242e96f8ead Mon Sep 17 00:00:00 2001
From: Corey Light <coreylight@gmail.com>
Date: Thu, 15 Feb 2018 10:07:38 -0600
Subject: [PATCH] docs(readme): change some language in readme, add example
 link

---
 README.md | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7e462c6e..d50c6410 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-<h1>iopipe-scripts 🛠📦</h1>
+<h1>@iopipe/scripts 🛠📦</h1>
 
 <p>Scripts for IOpipe projects</p>
 </div>
@@ -12,6 +12,7 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 
+- [Requirements](#requirements)
 - [Installation](#installation)
 - [Usage](#usage)
   - [Overriding Config](#overriding-config)
@@ -19,33 +20,37 @@
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
+## Requirements
+
+- Node v8.5 +
+
 ## Installation
 
 This module is distributed via [npm][npm] which is bundled with [node][node] and
 should be installed as one of your project's `devDependencies`:
 
 ```
-npm install --save-dev iopipe-scripts
+yarn add @iopipe/scripts --dev
 ```
 
 ## Usage
 
-This is a CLI and exposes a bin called `iopipe-scripts`. I don't really plan on
-documenting or testing it super duper well because it's really specific to my
-needs. You'll find all available scripts in `src/scripts`.
+This is a CLI and exposes a bin called iopipe-scripts.
+
+This project actually dogfoods itself. If you look in the package.json, you'll find scripts with node src {scriptName}. This serves as an example of some of the things you can do with iopipe-scripts.
+
+A great example of this package in use can be found at the [IOpipe event-info plugin repo](https://github.com/iopipe/iopipe-js-event-info/blob/master/package.json).
 
-This project actually dogfoods itself. If you look in the `package.json`, you'll
-find scripts with `node src {scriptName}`. This serves as an example of some
-of the things you can do with `iopipe-scripts`.
+You'll see that this repo uses scripts for linting, building, testing, and releasing. You'll also find the current recommended usage for eslint, until [this eslint issue is resolved](https://github.com/eslint/eslint/issues/9227).
 
 ### Overriding Config
 
-Unlike `react-scripts`, `iopipe-scripts` allows you to specify your own
+`@iopipe/scripts` allows you to specify your own
 configuration for things and have that plug directly into the way things work
-with `iopipe-scripts`. There are various ways that it works, but basically if you
+with `@iopipe/scripts`. There are various ways that it works, but basically if you
 want to have your own config for something, just add the configuration and
-`iopipe-scripts` will use that instead of it's own internal config. In addition,
-`iopipe-scripts` exposes its configuration so you can use it and override only
+`@iopipe/scripts` will use that instead of it's own internal config. In addition,
+`@iopipe/scripts` exposes its configuration so you can use it and override only
 the parts of the config you need to.
 
 This can be a very helpful way to make editor integration work for tools like
@@ -64,7 +69,7 @@ contents of:
 Or, for `babel`, a `.babelrc` with:
 
 ```
-{"presets": ["iopipe-scripts/babel"]}
+{"presets": ["./node_modules/@iopipe/scripts/babel"]}
 ```
 
 Or, for `jest`: