Skip to content
This repository has been archived by the owner on Jan 21, 2023. It is now read-only.

Update docs explaining dependency on Node 8 #98

Closed
wants to merge 1 commit into from
Closed

Update docs explaining dependency on Node 8 #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,9 @@ To start hacking, do the following:

Now you're ready to start local development!

### Caution
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section should be moved to the bottom so it won't look like export OG_HTML_DEBUG=1 is part of the Caution section.

Also you can link to this PR: #80


This project requires Node 8 to run. This is due to a dependency on `chrome-aws-lambda` which doesn't support Node versions higher than `8.10`. Please consult the [respective docs](https://github.com/alixaxel/chrome-aws-lambda#usage) before attempting to upgrade.


You can set an environment variable to assist with debugging `export OG_HTML_DEBUG=1`. This will render the image as HTML so you can play around with your browser's dev tools before committing changes to the template.