Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 2.3 KB

README.md

File metadata and controls

71 lines (43 loc) · 2.3 KB
Raw

Medusa Logo

Medusa

Medusa is a Chrome extension that reminds you to periodically look away from your computer screen.

A Screenshot of Medusa in action, telling you to look away

Inspiration

How To Keep Computer Screens From Destroying Your Eyes (The Atlantic)

Developing

Built With

HTML, CSS, Javascript, Chrome Extension APIs

Setting up

Here's how you can get set up:

  • First, fork the project
git clone https://github.com/<username>/medusa.git
cd medusa/
  • Go to chrome://extensions
  • Click "Load unpacked extension"
  • Browse to wherever you cloned the project and select that folder
  • Now you have a development version of Medusa running!

Seeing your changes

After making changes to the extension, you will want to "Reload extensions" on the chrome://extensions page. (Ctrl+R)

Publishing your Code

Go ahead and submit a Pull Request with:

  • Your changes to the code
  • An updated version number in manifest.json
  • Double-checking that your code matches the Style Guides below!

Versioning

  • For a minor bug fix, increment version number in manifest.json by 0.0.1
  • For a new feature implementation, increment version number by 0.1.0
  • For a major feature implementation or behaviour change, increment version number by 1.0.0

Style guide

Pull Requests regarding code style are welcome and encouraged.

Chrome API Reference

For your reference: the Chrome APIs that are exposed to extensions.

Licensing

This project is licensed under the MIT License. The MIT License is:

A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

For more information about the MIT License: tl;drLegal