diff --git a/README.md b/README.md index 8faa074..52da757 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ # websnap -Websnap is a firefox extension which will screenshot the entire page of a website, user can download the image in png, jpeg and gif. +Websnap is a Firefox extension which will take a screenshot of the entire page of a website (even content outside the viewport!). You can save the image in `png`, `jpeg`, and `gif` formats. # Installation -Go to our firefox add on page at [here](https://addons.mozilla.org/en-US/firefox/), just click "Add to firefox" and the installation will begun. +Go to our Firefox add-on page [here](https://addons.mozilla.org/firefox/addon/websnapp/). Just click "Add to Firefox" and the installation will begin. -After the installation, you will see the extension in your firefox toolbar. +After the installation, you will see the extension in your Firefox toolbar. ![screenshot of toolbar](docs/toolbar-icon-sc.jpg) -And voila! The installation is complete! +VoilĂ ! The installation is complete! # Usage -To start the screenshot, click the extension icon in your toolbar. +To take a screenshot, click the extension icon in your toolbar. ![gif of clicking the extension icon](docs/click-extension-icon.gif) -At the new page, you could preview your screenshot and choose to download in whatever format. +At the new page, you can preview your screenshot or choose to save it in the format you desire. ![gif of clicking the extension icon](docs/download-image.gif) @@ -25,6 +25,7 @@ At the new page, you could preview your screenshot and choose to download in wha [Open new issue](https://github.com/weiliang79/websnap/issues/new) # Contributing -Please feel free to submit an isue or a pull request. To develop, you will need a firefox browser and a code editor. +Please feel free to submit an issue or a pull request. To develop, you will need the Firefox web browser and a code editor. + # License -[MIT License]() \ No newline at end of file +[MIT License]()