Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
varholak-peter committed May 1, 2020
1 parent 3346fce commit acba7c7
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ node_modules
# Build directory
build/
dist/
day9tv-optimizer.zip

# Misc
.DS_Store
Expand Down
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Day9.tv Optimizer

A simple extension that provides some UX benefits to https://day9.tv/ visitors.

[Chrome Web Store](https://chrome.google.com/webstore/detail/day9tv-optimizer/jaehlnfcnnapnhookcomgmmmkojebdla)

## Configuration

### Accessibility

#### Font Contrast

Increases font contrast across the website to comply with WCAG AAA standard where possible. ([Contrast checker](https://webaim.org/resources/contrastchecker/))

#### Font Improvements

Some miscellaneous improvements to fonts that didn't fit anywhere else.

### Quality of Life

#### Form Scaling

Scale WYSIWYG input fields' height according to content.

## Development setup

Requires Yarn & Node.js

Running `yarn dev` starts webpack in watch mode and outputs the bundle in `build` folder.

Running `yarn build` builds a production version of the extension and outputs the bundle in `dist` folder.

For further info how to work with extensions visit [Getting Started - Google Chrome](https://developer.chrome.com/extensions/getstarted).

0 comments on commit acba7c7

Please sign in to comment.