From 0194b8dc9d0b6f66aeadd6a4337b44f27e185c98 Mon Sep 17 00:00:00 2001
From: Clay Smith <smithclay@gmail.com>
Date: Mon, 12 Mar 2018 17:23:27 -0700
Subject: [PATCH] add SAR readme

---
 README-SAR.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md     |  2 +-
 2 files changed, 58 insertions(+), 1 deletion(-)
 create mode 100644 README-SAR.md

diff --git a/README-SAR.md b/README-SAR.md
new file mode 100644
index 0000000..0f771d0
--- /dev/null
+++ b/README-SAR.md
@@ -0,0 +1,57 @@
+## lambdium
+### serverless application repository quickstart
+
+Lambdium allows you to run a Selenium Webdriver script written in Javascript inside of an AWS Lambda function bundled with a special version of Google Chrome (headless chrome).
+
+For example, this script uses Selenium to automate visiting the google.com homepage and print the title to the console:
+
+```
+console.log('About to visit google.com...');
+$browser.get('http://www.google.com/ncr');
+$browser.wait($driver.until.titleIs('Google'), 1000);
+$browser.getTitle().then(function(title) {
+    console.log("title is: " + title);
+});
+console.log('Finished running script!');
+``` 
+
+After running this script inside of of the AWS Lambda function running lambdium, you can look at Cloudwatch logs to read the output of the script:
+
+```
+23:37:332018-03-12T23:37:33.682Z	567babb5-264e-11e8-ae20-e37b20048a93	About to visit google.com...
+23:37:33 2018-03-12T23:37:33.682Z	567babb5-264e-11e8-ae20-e37b20048a93	Finished running script!
+23:37:36 2018-03-12T23:37:36.860Z	567babb5-264e-11e8-ae20-e37b20048a93	title is: Google
+```
+
+### running your first selenium script
+
+lambdium requires you to invoke it using a special event trigger: a JSON document with a single property called `Base64Script`, which is a Base64-encoded selenium script written in Javascript. The example which visits google.com looks like this:
+
+```
+{
+    "Base64Script": "Ly8gU2FtcGxlIHNlbGVuaW11bS13ZWJkcml2ZXIgc2NyaXB0IHRoYXQgdmlzaXRzIGdvb2dsZS5jb20KLy8gVGhpcyB1c2VzIHRoZSBzZWxlbml1bS13ZWJkcml2ZXIgMy40IHBhY2thZ2UuCi8vIERvY3M6IGh0dHBzOi8vc2VsZW5pdW1ocS5naXRodWIuaW8vc2VsZW5pdW0vZG9jcy9hcGkvamF2YXNjcmlwdC9tb2R1bGUvc2VsZW5pdW0td2ViZHJpdmVyL2luZGV4Lmh0bWwKLy8gJGJyb3dzZXIgPSB3ZWJkcml2ZXIgc2Vzc2lvbgovLyAkZHJpdmVyID0gZHJpdmVyIGxpYnJhcmllcwovLyBjb25zb2xlLmxvZyB3aWxsIG91dHB1dCB0byBBV1MgTGFtYmRhIGxvZ3MgKHZpYSBDbG91ZHdhdGNoKQoKY29uc29sZS5sb2coJ0Fib3V0IHRvIHZpc2l0IGdvb2dsZS5jb20uLi4nKTsKJGJyb3dzZXIuZ2V0KCdodHRwOi8vd3d3Lmdvb2dsZS5jb20vbmNyJyk7CiRicm93c2VyLmZpbmRFbGVtZW50KCRkcml2ZXIuQnkubmFtZSgnYnRuSycpKS5jbGljaygpOwokYnJvd3Nlci53YWl0KCRkcml2ZXIudW50aWwudGl0bGVJcygnR29vZ2xlJyksIDEwMDApOwokYnJvd3Nlci5nZXRUaXRsZSgpLnRoZW4oZnVuY3Rpb24odGl0bGUpIHsKICAgIGNvbnNvbGUubG9nKCJ0aXRsZSBpczogIiArIHRpdGxlKTsKfSk7CmNvbnNvbGUubG9nKCdGaW5pc2hlZCBydW5uaW5nIHNjcmlwdCEnKTs="
+}
+```
+
+To encode another script, you can paste the contents of a script in an online converter like [https://www.base64encode.org/](https://www.base64encode.org/) or using the following commands, which are also available as a simple shell script in `scripts/invoke.sh`:
+
+```
+SELENIUM_SCRIPT=/path/to/your/script
+BASE64_ENCODED=`cat $SELENIUM_SCRIPT | openssl base64`
+PAYLOAD_STRING='{"Base64Script": "'$BASE64_ENCODED'"}'
+echo $PAYLOAD_STRING
+```
+
+With the payload constructed, you can then invoke the function directly in the AWS Console by defining a test event or using the AWS CLI with the payload written to a file defined in the $PAYLOAD_FILE enviornment variable. Replace the function name with the name of the function deployed by the serverless application repository (it should be `lambdium` by default).
+
+```
+aws lambda invoke --invocation-type RequestResponse --function-name lambdium --payload file://$PAYLOAD_FILE --log-type Tail $OUTPUT_FILE
+``` 
+
+### troubleshooting
+
+Errors and failures will be written to Cloudwatch. The `DEBUG_ENV` environment variable outputs additional information about the filesystem and inputted Base64 script.
+
+The maximum payload size is 4kb and the default timeout is 10 seconds, so this won't work with very large scripts or scripts that run a long time.
+
+More details are available on the official Github page, https://github.com/smithclay/lambdium.
diff --git a/README.md b/README.md
index 3b03e04..26fe2d9 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 ## lambdium
 ### headless chrome + selenium webdriver in AWS Lambda
 
-> This project is now published on the [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com), allowing you to install it in your AWS account with one click. After deploy, you can execute the function with the test payload defined in `event.json`. Listing is [here](https://serverlessrepo.aws.amazon.com/#/applications/arn:aws:serverlessrepo:us-east-1:156280089524:applications~lambdium).
+*This project is now published on the [AWS Serverless Application Repository](https://serverlessrepo.aws.amazon.com), allowing you to install it in your AWS account with one click. Install in your AWS account [here](https://serverlessrepo.aws.amazon.com/#/applications/arn:aws:serverlessrepo:us-east-1:156280089524:applications~lambdium).* Quickstart instructions are in the [`README-SAR.md` file](https://github.com/smithclay/lambdium/blob/master/README-SAR.md).
 
 This uses the binaries from the [serverless-chrome](https://github.com/adieuadieu/serverless-chrome) project to prototype running headless chromium with `selenium-webdriver` in AWS Lambda. I've also bundled the chromedriver binary so the browser can be interacted with using the [Webdriver Protocol](https://www.w3.org/TR/webdriver/).