Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #12

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+17 −4
Open

Update README.md #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6d309c
Update README.md
mkiser Apr 2, 2019
379c1e1
formatting change.
mkiser Apr 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -3,12 +3,18 @@
[![Greenkeeper badge](https://badges.greenkeeper.io/postlight/mercury-parser-api.svg)](https://greenkeeper.io/)

This repo provides a drop-in replacement for the [Mercury Parser](https://github.com/postlight/mercury-parser) API.
In fact, this [AWS Lambda](https://aws.amazon.com/lambda/)-based API for running the Mercury Parser is the same code
and serverless infrastructure that powered the Mercury Parser API.
In fact, this [AWS Lambda](https://aws.amazon.com/lambda/)-based API for running the [Mercury Parser](https://mercury.postlight.com/web-parser/) is the same code
and serverless infrastructure that powered the Mercury Parser API. The AWS Lambda free tier provides 1,000,000 free requests per month.

## Installation


```bash
# Upgrade / install Node
sudo npm cache clean -f
sudo npm install -g n
sudo n stable

# If you don't already have the mercury parser api installed, do that
git clone https://github.com/postlight/mercury-parser-api.git

@@ -26,9 +32,16 @@ yarn serve

## Deploy

Assuming you've already [set up your default AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html#cli-quick-configuration) (or have set a different AWS profile via [the profile field](serverless.yml#L21)), simply run:
Before deploying, you need to:

1. [Install the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)

2. [Set up your default AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html#cli-quick-configuration) (or have set a different AWS profile via [the profile field](serverless.yml#L21)). Follow this [guide for setting up your credentials](https://serverless.com/framework/docs/providers/aws/guide/credentials/#creating-aws-access-keys), using this gist of [suggested AWS IAM permissions](https://gist.github.com/ServerlessBot/7618156b8671840a539f405dea2704c8)

To deploy, simply run:

```
```bash
yarn deploy
```