From 7eb70ca82646a95c2d255c945a28fdbb13076fef Mon Sep 17 00:00:00 2001
From: Stephen Kilbourn <skilbourn@element84.com>
Date: Thu, 29 Sep 2022 21:22:43 -0500
Subject: [PATCH] git update readme

---
 README.md    | 23 ++++++++++++++++++++---
 package.json |  2 +-
 2 files changed, 21 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c441071..c335a95 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,34 @@
 # 📜 🎭 Playwright Report Summary  🎭  📜
 
 Small text based custom reporter for Playwright.
+It can be handy to publish test results for things such as an SNS message or minimal Slack update. This Tool allows you to generate smaller reports with basic info about your test run.
 
-## Configuration
+## ✨ Installation ✨
 
-Modify your `playwright.config.ts` file to include the reporer:
+Run following commands:
+
+### npm
+
+`npm install @skilbournplaywright-report-summary --save-dev`
+
+### yarn
+
+`yarn add @skilbournplaywright-report-summary --dev`
+
+## 📍 Configuration 📍
+
+Modify your `playwright.config.ts` file to include the reporter:
 
 ```typescript
   reporter: [
-    ['./src/index.ts', { outputFile: 'summary.txt' }]]
+    ['@skilbourn/playwright-report-summary', { outputFile: 'custom-summary.txt' }]]
     ['html'], // other reporters
     ['dot']
   ],
 ```
 
 The default output location will be to your root as `summary.txt`  Including the `outputFile` parameter allows you to specify a custom report location.
+
+## Customizing Outputs
+
+Coming Soon
diff --git a/package.json b/package.json
index 88f6e53..662a1a1 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@skilbourn/playwright-report-summary",
-  "version": "0.0.10",
+  "version": "0.1.0",
   "description": "generate a customizable text summary of your playwright test results",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",